{"openapi":"3.1.0","info":{"title":"Sigma Computing Public REST API","version":"2.0.0+20260915.e7f79b1","summary":"The Sigma REST API provides developers access to resources programmatically, using HTTP.","description":"The Sigma REST API provides developers access to resources programmatically,\n    using HTTP. The API allows secure access to all the commonly used resources\n    like connections, datasets, teams, workbooks and more. It is designed to have\n    predictable, resource-oriented URLs and to use HTTP response codes to\n    indicate API errors. It uses built-in HTTP features, like HTTP\n    authentication and HTTP verbs, which are understood by off-the-shelf HTTP\n    clients. It supports cross-origin resource sharing, allowing you to interact\n    securely with the API from a client-side web application (though you should\n    never expose your client credentials or API token in any public website's client-side code).\n    JSON is returned by all API responses, including errors.\n    Some useful links:\n        - [API Reference Help](https://help.sigmacomputing.com/reference)\n        - [API QuickStart with Postman](https://quickstarts.sigmacomputing.com/guide/sigma_api_with_postman/index.html?index=..%2F..index#0)","termsOfService":"Contact Sigma","contact":{"email":"support@sigmacomputing.com"}},"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"bearerAuth":{"type":"http","scheme":"bearer"},"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/v2/auth/token","refreshUrl":"/v2/auth/token","scopes":{}}}}},"responses":{"ApiError":{"description":"Sigma API Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"requestId":{"type":"string"}}}}}}},"schemas":{"DashVariables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":["boolean","null"]}},"description":"","title":"boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"type":["number","null"]}},"description":"","title":"number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":["string","null"]}},"description":"","title":"text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"type":"null"},{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed"]},"date":{"type":"number"}}},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}}}]}},"description":"","title":"date"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"number"},{"type":"null"}]}}},"description":"","title":"number-list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"description":"","title":"text-list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"number"},{"type":"null"}]}}},"description":"","title":"date-list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"allOf":[{"type":"object","required":["true","false"],"properties":{"true":{"type":"boolean"},"false":{"type":"boolean"}}},{"type":"object","properties":{"null":{"type":"boolean"}}}]}},"description":"","title":"boolean-list"},{"type":"object","required":["type","min","max"],"properties":{"type":{"type":"string","enum":["date-range"]},"min":{"oneOf":[{"type":"null"},{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed"]},"date":{"type":"number"}}},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}}}]},"max":{"oneOf":[{"type":"null"},{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed"]},"date":{"type":"number"}}},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}}}]}},"description":"","title":"date-range"},{"type":"object","required":["type","min","max"],"properties":{"type":{"type":"string","enum":["number-range"]},"min":{"type":["number","null"]},"max":{"type":["number","null"]}},"description":"","title":"number-range"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"","title":"date-null"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}},"description":"","title":"number-null"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}},"description":"","title":"text-null"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}},"description":"","title":"boolean-null"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["hierarchical-list"]},"value":{"type":"array","items":{"type":"string"}}},"description":"","title":"hierarchical-list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["file"]},"value":{"type":"object","required":["id","name","size","type","downloadUrl"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"size":{"type":"number"},"type":{"type":"string"},"downloadUrl":{"type":"string"}}}},"description":"","title":"file"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["file-null"]}},"description":"","title":"file-null"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["file-list"]},"value":{"type":"array","items":{"type":"object","required":["id","name","size","type","downloadUrl"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"size":{"type":"number"},"type":{"type":"string"},"downloadUrl":{"type":"string"}}}}},"description":"","title":"file-list"}],"type":"object"}},"ReportElement":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/CommonElement"}],"title":"Common elements"},{"allOf":[{"type":"object","required":["id","kind","source"],"properties":{"id":{"type":"string","description":"The identifier of the report repeated container."},"kind":{"type":"string","enum":["report-repeated-container"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source used to generate cards in the repeated container."}}},{"type":"object","properties":{"arrangement":{"oneOf":[{"type":"string","enum":["list"]},{"type":"string","enum":["grid"]}],"description":"How cards are tiled inside the repeated container. Defaults to `grid`."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The styling of the element, including background, border, corner shape, and padding."},"cardStyle":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The styling applied to each card including background color, border, corner shape, and padding."},"noDataText":{"type":"string","description":"The message shown when the data source has no rows."},"cardGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"The gap between cards in the repeated container. Defaults to `shown`."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether there's a gap between elements inside each card. Defaults to `shown`."},"cardSpacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Gap/padding size between cards (pairs with cardGap). Small, medium, or large."},"elementSpacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The gap between elements inside each card. When padding is enabled, also determines padding size."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"The sort order applied to the source rows behind the cards. Requires a `source` of `table`."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The column filters applied to the source rows that drive the repeated container cards."}}},{"type":"object","properties":{"containerSize":{"type":"object","properties":{"width":{"type":"number","description":"Card template width in pixels."},"height":{"type":"number","description":"Card template height in pixels."}},"description":"Pixel size of the repeated card template."},"numRows":{"type":"number","description":"Number of card rows shown per page when arrangement is grid."},"numColumns":{"type":"number","description":"Number of card columns shown per page when arrangement is grid."},"pageBreakAfterRows":{"type":"boolean","description":"When true, insert a page break after each filled set of card rows."},"cardContentHeight":{"type":"number","description":"Explicit card content height in pixels. Resizing scales template children to fit."}}}],"description":"","title":"Report repeated container"}]},"TableStyle":{"type":"object","properties":{"preset":{"oneOf":[{"type":"string","enum":["spreadsheet"]},{"type":"string","enum":["presentation"]}],"description":"The table style preset. Defaults to `spreadsheet`."},"cellSpacing":{"oneOf":[{"type":"string","enum":["extra-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The cell spacing preset."},"gridLines":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["vertical"]},{"type":"string","enum":["horizontal"]},{"type":"string","enum":["all"]}],"description":"The grid line display."},"banding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"The row banding visibility for alternating data rows."},"bandingColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"autofitColumns":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether table columns autofit to their content. Rejected on a pivot table."},"outerBorder":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the table draws an outer border."},"headerDividerColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"heavyVerticalDividers":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether heavier vertical dividers between pivot column groups are shown. On an element `tableStyle`, valid only on `kind: 'pivot-table'`."},"heavyHorizontalDividers":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether heavier horizontal dividers between pivot row groups are shown. On an element `tableStyle`, valid only on `kind: 'pivot-table'`."},"textStyles":{"type":"object","properties":{"header":{"type":"object","properties":{"font":{"type":"string","description":"The font family name for the table text."},"fontSize":{"type":"number","description":"The font size, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal text alignment."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical text alignment."},"textWrap":{"oneOf":[{"type":"string","enum":["wrap"]},{"type":"string","enum":["clip"]}],"description":"The text overflow behavior. Defaults to `clip`."}}},"cell":{"type":"object","properties":{"font":{"type":"string","description":"The font family name for the table text."},"fontSize":{"type":"number","description":"The font size, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal text alignment."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical text alignment."},"textWrap":{"oneOf":[{"type":"string","enum":["wrap"]},{"type":"string","enum":["clip"]}],"description":"The text overflow behavior. Defaults to `clip`."}}},"columnHeader":{"type":"object","properties":{"font":{"type":"string","description":"The font family name for the table text."},"fontSize":{"type":"number","description":"The font size, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal text alignment."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical text alignment."},"textWrap":{"oneOf":[{"type":"string","enum":["wrap"]},{"type":"string","enum":["clip"]}],"description":"The text overflow behavior. Defaults to `clip`."}}},"rowHeader":{"type":"object","properties":{"font":{"type":"string","description":"The font family name for the table text."},"fontSize":{"type":"number","description":"The font size, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal text alignment."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical text alignment."},"textWrap":{"oneOf":[{"type":"string","enum":["wrap"]},{"type":"string","enum":["clip"]}],"description":"The text overflow behavior. Defaults to `clip`."}}}}}}},"WorkbookSpec":{"allOf":[{"allOf":[{"type":"object","required":["workbookId"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"}}},{"type":"object","required":["name","url","documentVersion","latestDocumentVersion","ownerId","folderId","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"name":{"type":"string","description":"The name of the workbook."},"url":{"type":"string","description":"The full URL for the requested document version of the workbook."},"documentVersion":{"type":"number","description":"The document version of the workbook."},"latestDocumentVersion":{"type":"number","description":"The most recently published document version of the workbook."},"ownerId":{"type":"string","description":"The identifier of the user who owns the workbook."},"folderId":{"type":"string","description":"The identifier of the folder in which the workbook is located."},"createdBy":{"type":"string","description":"The identifier of the user who created the workbook."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated the workbook."},"createdAt":{"type":"string","format":"date-time","description":"When the workbook was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the workbook was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the workbook."}}}]},{"type":"object","required":["document"],"properties":{"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the workbook."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["workbook"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages of the workbook."}}},{"type":"object","required":["elements"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/WorkbookElement"},"description":"The elements in this workbook and their definitions."}}},{"type":"object","properties":{"overlays":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the modal page."},"type":{"type":"string","enum":["modal"],"description":"Marks this page as a modal."},"name":{"type":"string","description":"The name of the modal."}}},{"type":"object","properties":{"modal":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"footer":{"type":"object","properties":{"primaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The primary footer button."},"secondaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The secondary footer button."}},"description":"The footer with primary and secondary buttons."}}}],"description":"The modal presentation options, including width, header, and footer buttons."},"singleRowContainer":{"allOf":[{"type":"object","required":["source","keyColumnId"],"properties":{"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source that supplies the displayed row."},"keyColumnId":{"type":"string","description":"The ID of the source column that identifies which row is displayed. Must be a column declared on the source."}}},{"type":"object","properties":{"keyColumnValue":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The key-column value of the row to display. Must match the key column type. Omit to pin no row."}}}],"description":"Pins the modal to one row of a source: the elements inside it show that row. Omit for an ordinary modal."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions on the modal. Each action's `trigger` must be one of `on-primary-cta-click`, `on-secondary-cta-click`, or `on-close`."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The background image for the modal. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Modal"},{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the drawer page."},"type":{"type":"string","enum":["drawer"],"description":"Marks this page as a drawer."},"name":{"type":"string","description":"The name of the drawer."}}},{"type":"object","properties":{"drawer":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"showShadow":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to display the drawer as a page overlay, dimming the page behind it when open. Either `shown` to dim the background page or `hidden` for none."}}}],"description":"The presentation of the drawer, including width, header, and page overlay."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by the drawer, on close."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"Background image for the drawer. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Drawer"},{"allOf":[{"type":"object","required":["id","type","name","popover"],"properties":{"id":{"type":"string","description":"The identifier of the popover page."},"type":{"type":"string","enum":["popover"],"description":"Marks this page as a popover."},"name":{"type":"string","description":"The name of the popover."},"popover":{"allOf":[{"type":"object","required":["triggerElementId"],"properties":{"triggerElementId":{"type":"string","description":"The identifier of the button that triggers the popover."}}},{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"Popover width breakpoint: x-small, small, medium, large, or x-large."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"padding":{"type":"string","enum":["none"],"description":"Set to 'none' to remove padding from the popover."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Gap between popover elements: 'shown' (default) or 'hidden'."}}}],"description":"Popover presentation: trigger button, width, spacing, padding, and element gap."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions fired by the popover when it closes."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Popover"}]},"description":"The modals, drawers, and popovers in this workbook and their contents."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page header."},"type":{"type":"string","enum":["header"],"description":"Identifies this panel as a page header."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the header."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["shadow"]},{"type":"string","enum":["none"]}],"description":"The border drawn below the header. One of `line`, `shadow`, or `none`. `shadow` applies only when `scroll` is `sticky`."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The header presentation, including scroll behavior, border, background, and height."}}}],"title":"PageHeader"},{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page sidebar."},"type":{"type":"string","enum":["sidebar"],"description":"Identifies this panel as a page sidebar."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the sidebar."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"width":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Sidebar width preset. One of `small` (200px), `medium` (260px), or `large` (400px). Defaults to `medium`."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["none"]}],"description":"The border style for the sidebar."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The sidebar presentation, including scroll behavior, border, and background color."}}}],"title":"PageSidebar"}]},"description":"The definitions of page headers and sidebars in this document."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}},{"type":"object","properties":{"agents":{"type":"array","items":{"allOf":[{"type":"object","required":["id","instructions"],"properties":{"id":{"type":"string","description":"The identifier of the agent."},"instructions":{"type":"string","description":"Instructions that guide the agent. Use `{{formula}}` for dynamic values, `@dataSource(\"elementId\")` for configured data sources, and `@tool(\"toolId\")` for configured tools."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the agent."},"description":{"type":"string","description":"The description of the agent."},"greeting":{"oneOf":[{"type":"object","required":["mode","message"],"properties":{"mode":{"type":"string","enum":["static"]},"message":{"type":"string","description":"The first message an agent displays when the chat opens. Not generated by the AI provider. Supports dynamic `{{formula}}` text."}},"description":"","title":"Fixed greeting"},{"type":"object","required":["mode","prompt"],"properties":{"mode":{"type":"string","enum":["generated"]},"prompt":{"type":"string","description":"The prompt the agent uses to generate the first message displayed when the chat opens. Supports dynamic `{{formula}}` text."}},"description":"","title":"Generated greeting"}],"description":"The greeting message for the agent. Set `mode` to `static` with a `message`, or `generated` with a `prompt`. Omit for the product default."},"dataSources":{"type":"array","items":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of a workbook element, such as a table or chart, the agent can read from."}},"description":"","title":"Workbook element"},"description":"The data elements or data model tables the agent can access."},"tools":{"type":"array","items":{"oneOf":[{"type":"object","required":["toolId","kind","connectorId","name"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["mcp-connector"]},"connectorId":{"type":"string","description":"The UUID of the MCP connector."},"name":{"type":"string","description":"The display name of the MCP connector."}},"description":"","title":"MCP connector"},{"allOf":[{"type":"object","required":["toolId","kind"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["warehouse-agent"]}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of when the agent should invoke this warehouse agent."}}}],"description":"","title":"Warehouse agent"},{"allOf":[{"type":"object","required":["toolId","kind","description"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["search-service"]},"description":{"type":"string","description":"A description of what this search service can retrieve, used by the agent to decide when to call it."}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}}],"description":"","title":"Search service"},{"allOf":[{"type":"object","required":["toolId","kind","name","description","steps"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["action"]},"name":{"type":"string","description":"The display name of the action tool."},"description":{"type":"string","description":"A description of what this tool does and when the agent should invoke it."},"steps":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["kind","sequenceId"],"properties":{"kind":{"type":"string","enum":["sequence"]},"sequenceId":{"type":"string","description":"The identifier of an action sequence in the workbook."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"","title":"Sequence reference"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["effect"]}}},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"An action effect to run. Effects that depend on user interaction, such as a selected row or column, are not supported.","title":"Inline effect"}]},"description":"The steps the agent runs when it invokes this action tool."}}},{"type":"object","properties":{"requiresApproval":{"type":"boolean","description":"Whether the agent must pause to get user approval before running this tool. Defaults to `false`."}}}],"description":"","title":"Action"}]},"description":"The tools the agent can invoke to take action or enrich insights."}}}]},"description":"The agents defined in the workbook. Reference one from a chat element using `agentId`."}}},{"type":"object","properties":{"automatedActions":{"type":"array","items":{"allOf":[{"type":"object","required":["effects","id","schedule","trigger"],"properties":{"effects":{"type":"array","items":{"allOf":[{"type":"object","required":["agentId","effect","prompt"],"properties":{"agentId":{"type":"string","description":"The identifier of the Sigma agent to run in this workbook."},"effect":{"type":"string","enum":["call-agent"]},"prompt":{"type":"string","description":"The instructions passed to the agent when the action runs."}}},{"type":"object","properties":{"actionVariables":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the action variable for the agent to return the value from."},"type":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["integer"]},{"type":"string","enum":["boolean"]},{"type":"string","enum":["datetime"]}],"description":"Scalar data type of the action variable."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the action variable."}}}]},"description":"The action variables populated from the agent response."}}}]},"description":"The actions that run when the schedule triggers."},"id":{"type":"string","description":"The stable identifier for this automated action sequence."},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"The cron expression that determines when the scheduled action runs. E.g., `0 9 * * 1` runs every Monday at 9:00 AM."},"timezone":{"type":"string","description":"The IANA timezone used to evaluate the cron expression."}},"description":"The configuration of a recurring schedule. Includes a cron expression and timezone."},"trigger":{"type":"string","enum":["schedule"],"description":"Runs the automated action sequence on a recurring schedule."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for the automated action sequence."},"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the automated action sequence is turned on or off."}}}]},"description":"The action sequences that run automatically on a schedule or webhook trigger."}}}]},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["workbook"],"description":"Document kind. Always `workbook` for this resource."}}}]},{"type":"object","required":["layout"],"properties":{"layout":{"type":"string","description":"Grid layout as XML.","title":"Layout XML"}}}],"description":"The code representation of the workbook: its pages, elements, columns, sources, layout, and theme. Submit this object as the `document` field of a create or update request to reproduce the workbook. Everything outside `document` is workbook metadata that Sigma maintains, and is ignored when you write.","title":"Workbook Document"}}}]},"CreateWorkbookSpec":{"allOf":[{"type":"object","required":["name","folderId","document"],"properties":{"name":{"type":"string","description":"The name of the workbook."},"folderId":{"type":"string","description":"The identifier of the folder in which the workbook is located."},"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the workbook."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["workbook"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages of the workbook."}}},{"type":"object","required":["elements"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/WorkbookElement"},"description":"The elements in this workbook and their definitions."}}},{"type":"object","properties":{"overlays":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the modal page."},"type":{"type":"string","enum":["modal"],"description":"Marks this page as a modal."},"name":{"type":"string","description":"The name of the modal."}}},{"type":"object","properties":{"modal":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"footer":{"type":"object","properties":{"primaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The primary footer button."},"secondaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The secondary footer button."}},"description":"The footer with primary and secondary buttons."}}}],"description":"The modal presentation options, including width, header, and footer buttons."},"singleRowContainer":{"allOf":[{"type":"object","required":["source","keyColumnId"],"properties":{"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source that supplies the displayed row."},"keyColumnId":{"type":"string","description":"The ID of the source column that identifies which row is displayed. Must be a column declared on the source."}}},{"type":"object","properties":{"keyColumnValue":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The key-column value of the row to display. Must match the key column type. Omit to pin no row."}}}],"description":"Pins the modal to one row of a source: the elements inside it show that row. Omit for an ordinary modal."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions on the modal. Each action's `trigger` must be one of `on-primary-cta-click`, `on-secondary-cta-click`, or `on-close`."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The background image for the modal. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Modal"},{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the drawer page."},"type":{"type":"string","enum":["drawer"],"description":"Marks this page as a drawer."},"name":{"type":"string","description":"The name of the drawer."}}},{"type":"object","properties":{"drawer":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"showShadow":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to display the drawer as a page overlay, dimming the page behind it when open. Either `shown` to dim the background page or `hidden` for none."}}}],"description":"The presentation of the drawer, including width, header, and page overlay."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by the drawer, on close."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"Background image for the drawer. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Drawer"},{"allOf":[{"type":"object","required":["id","type","name","popover"],"properties":{"id":{"type":"string","description":"The identifier of the popover page."},"type":{"type":"string","enum":["popover"],"description":"Marks this page as a popover."},"name":{"type":"string","description":"The name of the popover."},"popover":{"allOf":[{"type":"object","required":["triggerElementId"],"properties":{"triggerElementId":{"type":"string","description":"The identifier of the button that triggers the popover."}}},{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"Popover width breakpoint: x-small, small, medium, large, or x-large."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"padding":{"type":"string","enum":["none"],"description":"Set to 'none' to remove padding from the popover."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Gap between popover elements: 'shown' (default) or 'hidden'."}}}],"description":"Popover presentation: trigger button, width, spacing, padding, and element gap."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions fired by the popover when it closes."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Popover"}]},"description":"The modals, drawers, and popovers in this workbook and their contents."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page header."},"type":{"type":"string","enum":["header"],"description":"Identifies this panel as a page header."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the header."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["shadow"]},{"type":"string","enum":["none"]}],"description":"The border drawn below the header. One of `line`, `shadow`, or `none`. `shadow` applies only when `scroll` is `sticky`."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The header presentation, including scroll behavior, border, background, and height."}}}],"title":"PageHeader"},{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page sidebar."},"type":{"type":"string","enum":["sidebar"],"description":"Identifies this panel as a page sidebar."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the sidebar."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"width":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Sidebar width preset. One of `small` (200px), `medium` (260px), or `large` (400px). Defaults to `medium`."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["none"]}],"description":"The border style for the sidebar."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The sidebar presentation, including scroll behavior, border, and background color."}}}],"title":"PageSidebar"}]},"description":"The definitions of page headers and sidebars in this document."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}},{"type":"object","properties":{"agents":{"type":"array","items":{"allOf":[{"type":"object","required":["id","instructions"],"properties":{"id":{"type":"string","description":"The identifier of the agent."},"instructions":{"type":"string","description":"Instructions that guide the agent. Use `{{formula}}` for dynamic values, `@dataSource(\"elementId\")` for configured data sources, and `@tool(\"toolId\")` for configured tools."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the agent."},"description":{"type":"string","description":"The description of the agent."},"greeting":{"oneOf":[{"type":"object","required":["mode","message"],"properties":{"mode":{"type":"string","enum":["static"]},"message":{"type":"string","description":"The first message an agent displays when the chat opens. Not generated by the AI provider. Supports dynamic `{{formula}}` text."}},"description":"","title":"Fixed greeting"},{"type":"object","required":["mode","prompt"],"properties":{"mode":{"type":"string","enum":["generated"]},"prompt":{"type":"string","description":"The prompt the agent uses to generate the first message displayed when the chat opens. Supports dynamic `{{formula}}` text."}},"description":"","title":"Generated greeting"}],"description":"The greeting message for the agent. Set `mode` to `static` with a `message`, or `generated` with a `prompt`. Omit for the product default."},"dataSources":{"type":"array","items":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of a workbook element, such as a table or chart, the agent can read from."}},"description":"","title":"Workbook element"},"description":"The data elements or data model tables the agent can access."},"tools":{"type":"array","items":{"oneOf":[{"type":"object","required":["toolId","kind","connectorId","name"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["mcp-connector"]},"connectorId":{"type":"string","description":"The UUID of the MCP connector."},"name":{"type":"string","description":"The display name of the MCP connector."}},"description":"","title":"MCP connector"},{"allOf":[{"type":"object","required":["toolId","kind"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["warehouse-agent"]}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of when the agent should invoke this warehouse agent."}}}],"description":"","title":"Warehouse agent"},{"allOf":[{"type":"object","required":["toolId","kind","description"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["search-service"]},"description":{"type":"string","description":"A description of what this search service can retrieve, used by the agent to decide when to call it."}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}}],"description":"","title":"Search service"},{"allOf":[{"type":"object","required":["toolId","kind","name","description","steps"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["action"]},"name":{"type":"string","description":"The display name of the action tool."},"description":{"type":"string","description":"A description of what this tool does and when the agent should invoke it."},"steps":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["kind","sequenceId"],"properties":{"kind":{"type":"string","enum":["sequence"]},"sequenceId":{"type":"string","description":"The identifier of an action sequence in the workbook."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"","title":"Sequence reference"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["effect"]}}},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"An action effect to run. Effects that depend on user interaction, such as a selected row or column, are not supported.","title":"Inline effect"}]},"description":"The steps the agent runs when it invokes this action tool."}}},{"type":"object","properties":{"requiresApproval":{"type":"boolean","description":"Whether the agent must pause to get user approval before running this tool. Defaults to `false`."}}}],"description":"","title":"Action"}]},"description":"The tools the agent can invoke to take action or enrich insights."}}}]},"description":"The agents defined in the workbook. Reference one from a chat element using `agentId`."}}},{"type":"object","properties":{"automatedActions":{"type":"array","items":{"allOf":[{"type":"object","required":["effects","id","schedule","trigger"],"properties":{"effects":{"type":"array","items":{"allOf":[{"type":"object","required":["agentId","effect","prompt"],"properties":{"agentId":{"type":"string","description":"The identifier of the Sigma agent to run in this workbook."},"effect":{"type":"string","enum":["call-agent"]},"prompt":{"type":"string","description":"The instructions passed to the agent when the action runs."}}},{"type":"object","properties":{"actionVariables":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the action variable for the agent to return the value from."},"type":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["integer"]},{"type":"string","enum":["boolean"]},{"type":"string","enum":["datetime"]}],"description":"Scalar data type of the action variable."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the action variable."}}}]},"description":"The action variables populated from the agent response."}}}]},"description":"The actions that run when the schedule triggers."},"id":{"type":"string","description":"The stable identifier for this automated action sequence."},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"The cron expression that determines when the scheduled action runs. E.g., `0 9 * * 1` runs every Monday at 9:00 AM."},"timezone":{"type":"string","description":"The IANA timezone used to evaluate the cron expression."}},"description":"The configuration of a recurring schedule. Includes a cron expression and timezone."},"trigger":{"type":"string","enum":["schedule"],"description":"Runs the automated action sequence on a recurring schedule."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for the automated action sequence."},"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the automated action sequence is turned on or off."}}}]},"description":"The action sequences that run automatically on a schedule or webhook trigger."}}}]},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["workbook"],"description":"Document kind. Always `workbook` for this resource."}}}]},{"type":"object","required":["layout"],"properties":{"layout":{"type":"string","description":"Grid layout as XML.","title":"Layout XML"}}}],"description":"The code representation of the workbook to write: its pages, elements, columns, sources, layout, and theme.","title":"Workbook Document"}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the workbook."}}}]},"WorkbookElement":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/CommonElement"}],"title":"Common elements"},{"allOf":[{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string","description":"The identifier of the chat element."},"kind":{"type":"string","enum":["chat"]}}},{"type":"object","properties":{"agentId":{"type":"string","description":"The identifier of the workbook agent, declared in `agents`, connected to this chat element. Omit when the chat has no agent, or when its agent is not a workbook agent."}}}],"description":"","title":"Chat"},{"allOf":[{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string","description":"The identifier of the code element."},"kind":{"type":"string","enum":["code"]}}},{"type":"object","properties":{"code":{"type":"string","description":"Python code the element runs, as written in the code editor. Empty until code is saved."},"connectionId":{"type":"string","description":"Identifier of the connection the code runs on. Absent when the element has no connection yet."}}}],"description":"","title":"Code"},{"allOf":[{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string","description":"The identifier of the container."},"kind":{"type":"string","enum":["container"]}}},{"type":"object","properties":{"conditionalFormats":{"type":"array","items":{"type":"object","required":["id","formula","config"],"properties":{"id":{"type":"string"},"formula":{"type":"string","description":"Boolean formula."},"config":{"type":"object","required":["backgroundColor"],"properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Background color."}}}}},"description":"Conditional formatting rules, evaluated in order. The first matching rule determines the container's background color."}}},{"type":"object","properties":{"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The background image of the container. The URL supports dynamic `{{formula}}` text."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"The gap between child elements. Defaults to `shown`."}}}],"description":"","title":"Container"},{"allOf":[{"$ref":"#/components/schemas/Form"}],"title":"Form"},{"allOf":[{"type":"object","required":["id","kind","source"],"properties":{"id":{"type":"string","description":"The identifier of the repeated container."},"kind":{"type":"string","enum":["repeated-container"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source used to generate cards in the repeated container."}}},{"type":"object","properties":{"arrangement":{"oneOf":[{"type":"string","enum":["list"]},{"type":"string","enum":["grid"]}],"description":"How cards are tiled inside the repeated container. Defaults to `grid`."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The styling of the element, including background, border, corner shape, and padding."},"cardStyle":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The styling applied to each card including background color, border, corner shape, and padding."},"noDataText":{"type":"string","description":"The message shown when the data source has no rows."},"cardGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"The gap between cards in the repeated container. Defaults to `shown`."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether there's a gap between elements inside each card. Defaults to `shown`."},"cardSpacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Gap/padding size between cards (pairs with cardGap). Small, medium, or large."},"elementSpacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The gap between elements inside each card. When padding is enabled, also determines padding size."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"The sort order applied to the source rows behind the cards. Requires a `source` of `table`."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The column filters applied to the source rows that drive the repeated container cards."}}},{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["vertical"]},{"type":"string","enum":["horizontal"]},{"type":"string","enum":["none"]}],"description":"The scroll behavior for overflowing cards. Defaults to vertical scrolling."},"cardStyle":{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}]},{"type":"object","properties":{"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"External image URL (supports {{formula}} references). Uploads are not supported."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}]}}}],"description":"Per-card styling: background, border, corners, padding toggle, and optional URL-only background image (uploads not supported)."},"cardSize":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The preset card width for the `grid` layout type. Defaults to `medium`."},"conditionalFormats":{"type":"array","items":{"type":"object","required":["id","formula","config"],"properties":{"id":{"type":"string"},"formula":{"type":"string","description":"Boolean formula."},"config":{"type":"object","required":["backgroundColor"],"properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Background color."}}}}},"description":"Conditional formatting rules, evaluated in order. The first matching rule determines the background color."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Repeated container"},{"allOf":[{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string","description":"The identifier of the single-row container."},"kind":{"type":"string","enum":["single-row-container"]}}},{"allOf":[{"type":"object","required":["source","keyColumnId"],"properties":{"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source that supplies the displayed row."},"keyColumnId":{"type":"string","description":"The ID of the source column that identifies which row is displayed. Must be a column declared on the source."}}},{"type":"object","properties":{"keyColumnValue":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The key-column value of the row to display. Must match the key column type. Omit to pin no row."}}}]},{"type":"object","properties":{"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The background image of the container. The URL supports dynamic `{{formula}}` text."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"The gap between child elements. Defaults to `shown`."}}}],"description":"","title":"Single-row container"},{"allOf":[{"type":"object","required":["id","kind","tabs"],"properties":{"id":{"type":"string","description":"The identifier of the tabbed container."},"kind":{"type":"string","enum":["tabbed-container"]},"tabs":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The label shown on the tab."}}},"description":"The ordered list of tabs in the tabbed container. Must contain at least one tab. The first tab is the default. The `layout` for each tab is matched to this list by position."}}},{"type":"object","properties":{"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"The gap between child elements. Defaults to `shown`."},"tabBar":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the tab bar is shown. Defaults to `shown`."},"style":{"oneOf":[{"type":"string","enum":["open"]},{"type":"string","enum":["box"]},{"type":"string","enum":["button"]}],"description":"The tab style. Defaults to `open`."},"alignment":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]},{"type":"string","enum":["justify"]}]},"size":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The tab bar size. Defaults to `medium`."}},"description":"The tab bar display options for the tabbed container."}}}],"description":"","title":"Tabbed container"},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string","description":"The identifier of the navigation element."},"kind":{"type":"string","enum":["navigation"]}}},{"type":"object","properties":{"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"optionStyle":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["pill"]}],"description":"The option style. Defaults to `line`."},"orientation":{"oneOf":[{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"The layout direction. Defaults to `horizontal`."},"alignment":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]},{"type":"string","enum":["justify"]}],"description":"The horizontal alignment of the navigation options. Defaults to `left`."},"size":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The size of the navigation options. Defaults to `medium`."},"textColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Label color for unselected options."},"selectedColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The label and color for the selected option."}},"description":"The appearance of the navigation options, including style, orientation, alignment, size, and colors."}}}]},{"type":"object","required":["mode","options"],"properties":{"mode":{"type":"string","enum":["manual"]},"options":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["submenu"],"properties":{"submenu":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The option label. Defaults to the destination's own label."},"icon":{"oneOf":[{"type":"object","required":["type","emoji"],"properties":{"type":{"type":"string","enum":["emoji"]},"emoji":{"type":"string"}},"description":"The emoji character.","title":"Emoji"},{"type":"object","required":["type","name","variant"],"properties":{"type":{"type":"string","enum":["icon"]},"name":{"$ref":"#/components/schemas/IconName"},"variant":{"oneOf":[{"type":"string","enum":["filled"]},{"type":"string","enum":["outlined"]},{"type":"string","enum":["toned"]}],"description":"The style of the icon. Required when `type` is `icon`."}},"description":"A named icon (by name and style variant).","title":"Icon"}],"description":"The icon displayed for this menu item."},"destination":{"oneOf":[{"type":"object","required":["type","pageId"],"properties":{"type":{"type":"string","enum":["page"]},"pageId":{"type":"string"}},"description":"The workbook page to navigate to.","title":"Page destination"},{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["element"]},"elementId":{"type":"string"}},"description":"The element on a page to navigate to.","title":"Element destination"},{"allOf":[{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"}}},{"type":"object","properties":{"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the link opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame). Defaults to `_blank`."}}}],"description":"The external URL to open.","title":"External link"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["none"]}},"description":"The option has no destination.","title":"No destination"}],"description":"The destination of the navigation option. One of a workbook `page`, an `element` anchor, an external `link`, or `none`."}}},"description":"The child options shown under this submenu, one level deep."}}},{"type":"object","properties":{"label":{"type":"string"},"icon":{"oneOf":[{"type":"object","required":["type","emoji"],"properties":{"type":{"type":"string","enum":["emoji"]},"emoji":{"type":"string"}},"description":"The emoji character.","title":"Emoji"},{"type":"object","required":["type","name","variant"],"properties":{"type":{"type":"string","enum":["icon"]},"name":{"$ref":"#/components/schemas/IconName"},"variant":{"oneOf":[{"type":"string","enum":["filled"]},{"type":"string","enum":["outlined"]},{"type":"string","enum":["toned"]}],"description":"The style of the icon. Required when `type` is `icon`."}},"description":"A named icon (by name and style variant).","title":"Icon"}],"description":"The icon displayed for this menu item."}}}],"description":"A submenu of menu items (one level).","title":"Submenu"},{"type":"object","properties":{"label":{"type":"string","description":"The option label. Defaults to the destination's own label."},"icon":{"oneOf":[{"type":"object","required":["type","emoji"],"properties":{"type":{"type":"string","enum":["emoji"]},"emoji":{"type":"string"}},"description":"The emoji character.","title":"Emoji"},{"type":"object","required":["type","name","variant"],"properties":{"type":{"type":"string","enum":["icon"]},"name":{"$ref":"#/components/schemas/IconName"},"variant":{"oneOf":[{"type":"string","enum":["filled"]},{"type":"string","enum":["outlined"]},{"type":"string","enum":["toned"]}],"description":"The style of the icon. Required when `type` is `icon`."}},"description":"A named icon (by name and style variant).","title":"Icon"}],"description":"The icon displayed for this menu item."},"destination":{"oneOf":[{"type":"object","required":["type","pageId"],"properties":{"type":{"type":"string","enum":["page"]},"pageId":{"type":"string"}},"description":"The workbook page to navigate to.","title":"Page destination"},{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["element"]},"elementId":{"type":"string"}},"description":"The element on a page to navigate to.","title":"Element destination"},{"allOf":[{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"}}},{"type":"object","properties":{"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the link opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame). Defaults to `_blank`."}}}],"description":"The external URL to open.","title":"External link"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["none"]}},"description":"The option has no destination.","title":"No destination"}],"description":"The destination of the navigation option. One of a workbook `page`, an `element` anchor, an external `link`, or `none`."}},"description":"A single navigation menu item.","title":"Menu item"}],"description":"A navigation menu item or a submenu of items."},"description":"The navigation options. At least one is required."}}},{"type":"object","properties":{"showIcons":{"type":"boolean","description":"Whether option icons are shown."}}}],"description":"A navigation menu whose options you define manually.","title":"Manual navigation"},{"allOf":[{"allOf":[{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string","description":"The identifier of the navigation element."},"kind":{"type":"string","enum":["navigation"]}}},{"type":"object","properties":{"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"optionStyle":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["pill"]}],"description":"The option style. Defaults to `line`."},"orientation":{"oneOf":[{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"The layout direction. Defaults to `horizontal`."},"alignment":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]},{"type":"string","enum":["justify"]}],"description":"The horizontal alignment of the navigation options. Defaults to `left`."},"size":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The size of the navigation options. Defaults to `medium`."},"textColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Label color for unselected options."},"selectedColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The label and color for the selected option."}},"description":"The appearance of the navigation options, including style, orientation, alignment, size, and colors."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["auto"]}}},{"type":"object","properties":{"pageLabels":{"type":"array","items":{"type":"object","required":["pageId","label"],"properties":{"pageId":{"type":"string","description":"Workbook page id."},"label":{"type":"string","description":"Custom navigation label for the page."}}},"description":"Display name overrides for a page, specified by page id."}}}],"description":"A navigation menu that lists the workbook's pages.","title":"Auto navigation"}],"description":"","title":"Navigation"},{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string","description":"The identifier of the page break element."},"kind":{"type":"string","enum":["page-break"]}},"description":"","title":"Page break"},{"allOf":[{"type":"object","required":["id","kind","fields"],"properties":{"id":{"type":"string","description":"The identifier of the value list element."},"kind":{"type":"string","enum":["value-list"]},"fields":{"type":"array","items":{"allOf":[{"type":"object","required":["fieldId","formula"],"properties":{"fieldId":{"type":"string","description":"Field id used to reference this field in formulas."},"formula":{"type":"string","description":"Formula text for the field value."}}},{"type":"object","properties":{"label":{"type":"string","description":"Display label for the field."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"Number or date display format for the field value."}}}],"description":"A single field in a value list."},"description":"The fields shown in this value list, in display order."}}},{"type":"object","properties":{"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The element background, border, and padding."},"hasGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether a gap is shown between fields."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Gap/padding size between fields."},"fieldLayout":{"oneOf":[{"allOf":[{"type":"object","required":["layoutType"],"properties":{"layoutType":{"type":"string","enum":["grid"]}}},{"type":"object","properties":{"labelWidth":{"oneOf":[{"type":"number","enum":[0.25]},{"type":"number","enum":[0.5]},{"type":"number","enum":[0.75]}],"description":"Label column width as a fraction. Defaults to 0.25."},"labelConfig":{"type":"object","properties":{"fontSize":{"type":"number","description":"Font size in pixels. Defaults to 14."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"Font weight. Defaults to 'normal'."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Styling applied to every field label."},"valueConfig":{"type":"object","properties":{"fontSize":{"type":"number","description":"Font size in pixels. Defaults to 14."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"Font weight. Defaults to 'normal'."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Styling applied to every field value."}}}]},{"allOf":[{"type":"object","required":["layoutType"],"properties":{"layoutType":{"type":"string","enum":["stacked"]}}},{"type":"object","properties":{"maxColumns":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]},{"type":"number","enum":[6]},{"type":"number","enum":[7]},{"type":"number","enum":[8]}],"description":"Number of columns. Defaults to 4."},"labelConfig":{"type":"object","properties":{"fontSize":{"type":"number","description":"Font size in pixels. Defaults to 14."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"Font weight. Defaults to 'normal'."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Styling applied to every field label."},"valueConfig":{"type":"object","properties":{"fontSize":{"type":"number","description":"Font size in pixels. Defaults to 14."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"Font weight. Defaults to 'normal'."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Styling applied to every field value."}}}]},{"allOf":[{"type":"object","required":["layoutType"],"properties":{"layoutType":{"type":"string","enum":["compact"]}}},{"type":"object","properties":{"labelConfig":{"type":"object","properties":{"fontSize":{"type":"number","description":"Font size in pixels. Defaults to 14."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"Font weight. Defaults to 'normal'."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Styling applied to every field label."},"valueConfig":{"type":"object","properties":{"fontSize":{"type":"number","description":"Font size in pixels. Defaults to 14."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"Font weight. Defaults to 'normal'."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Styling applied to every field value."}}}]},{"allOf":[{"type":"object","required":["layoutType"],"properties":{"layoutType":{"type":"string","enum":["separated"]}}},{"type":"object","properties":{"labelConfig":{"type":"object","properties":{"fontSize":{"type":"number","description":"Font size in pixels. Defaults to 14."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"Font weight. Defaults to 'normal'."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Styling applied to every field label."},"valueConfig":{"type":"object","properties":{"fontSize":{"type":"number","description":"Font size in pixels. Defaults to 14."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"Font weight. Defaults to 'normal'."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Styling applied to every field value."}}}]}],"description":"Layout and text styling shared across all fields. Defaults to a grid layout."}}}],"description":"","title":"Value list"}]},"Actions":{"type":"array","items":{"allOf":[{"type":"object","required":["id","trigger","effects"],"properties":{"id":{"type":"string","description":"The identifier of the action sequence."},"trigger":{"oneOf":[{"oneOf":[{"type":"string","enum":["on-click"]},{"type":"string","enum":["on-select"]},{"type":"string","enum":["on-primary-cta-click"]},{"type":"string","enum":["on-secondary-cta-click"]},{"type":"string","enum":["on-close"]},{"type":"string","enum":["on-change"]},{"type":"string","enum":["on-submit"]},{"type":"string","enum":["on-reset"]}]},{"type":"object","required":["on","condition"],"properties":{"on":{"oneOf":[{"type":"string","enum":["on-click"]},{"type":"string","enum":["on-select"]},{"type":"string","enum":["on-primary-cta-click"]},{"type":"string","enum":["on-secondary-cta-click"]},{"type":"string","enum":["on-close"]},{"type":"string","enum":["on-change"]},{"type":"string","enum":["on-submit"]},{"type":"string","enum":["on-reset"]}]},"condition":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The host element's own column ID to compare."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"The condition that must evaluate to true for the action to run.","title":"Column Condition"},{"type":"object","required":["type","cond","value"],"properties":{"type":{"type":"string","enum":["constant"]},"cond":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["In"]}],"description":"The comparison operator applied to `value`. Either `=` for equality, or `In` for membership when the triggering control is a list."},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"Condition that compares the control's value to a constant. Only valid on a control-sourced trigger.","title":"Constant Condition"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The boolean formula that determines whether the action sequence runs."}},"description":"Boolean formula evaluated using values from the trigger context.","title":"Formula Condition"}]}}},{"allOf":[{"type":"object","required":["on","menuItemId"],"properties":{"on":{"type":"string","enum":["on-context-menu-click"]},"menuItemId":{"type":"string","description":"The customContextMenu item's id this trigger targets."}}},{"type":"object","properties":{"condition":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The host element's own column ID to compare."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"The condition that must evaluate to true for the action to run.","title":"Column Condition"},{"type":"object","required":["type","cond","value"],"properties":{"type":{"type":"string","enum":["constant"]},"cond":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["In"]}],"description":"The comparison operator applied to `value`. Either `=` for equality, or `In` for membership when the triggering control is a list."},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"Condition that compares the control's value to a constant. Only valid on a control-sourced trigger.","title":"Constant Condition"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The boolean formula that determines whether the action sequence runs."}},"description":"Boolean formula evaluated using values from the trigger context.","title":"Formula Condition"}]}}}]},{"allOf":[{"type":"object","required":["kind","actionTriggerId"],"properties":{"kind":{"type":"string","enum":["action-trigger"]},"actionTriggerId":{"type":"string","description":"The identifier of the action trigger that fires this action."}}},{"type":"object","properties":{"condition":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The host element's own column ID to compare."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"The condition that must evaluate to true for the action to run.","title":"Column Condition"},{"type":"object","required":["type","cond","value"],"properties":{"type":{"type":"string","enum":["constant"]},"cond":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["In"]}],"description":"The comparison operator applied to `value`. Either `=` for equality, or `In` for membership when the triggering control is a list."},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"Condition that compares the control's value to a constant. Only valid on a control-sourced trigger.","title":"Constant Condition"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The boolean formula that determines whether the action sequence runs."}},"description":"Boolean formula evaluated using values from the trigger context.","title":"Formula Condition"}]}}}]}],"description":"The user interaction that initiates this action, such as a button click or cell selection."},"effects":{"type":"array","items":{"oneOf":[{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},{"allOf":[{"type":"object","required":["effect","if"],"properties":{"effect":{"type":"string","enum":["if-else"]},"if":{"type":"object","required":["condition","effects"],"properties":{"condition":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The host element's own column ID to compare."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"The condition that must evaluate to true for the action to run.","title":"Column Condition"},{"type":"object","required":["type","cond","value"],"properties":{"type":{"type":"string","enum":["constant"]},"cond":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["In"]}],"description":"The comparison operator applied to `value`. Either `=` for equality, or `In` for membership when the triggering control is a list."},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"Condition that compares the control's value to a constant. Only valid on a control-sourced trigger.","title":"Constant Condition"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The boolean formula that determines whether the action sequence runs."}},"description":"Boolean formula evaluated using values from the trigger context.","title":"Formula Condition"}],"description":"The condition that selects this branch."},"effects":{"type":"array","items":{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},"description":"Effects that run when this branch is selected."}},"description":"Runs when its condition is true."}}},{"type":"object","properties":{"elseif":{"type":"array","items":{"type":"object","required":["condition","effects"],"properties":{"condition":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The host element's own column ID to compare."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"The condition that must evaluate to true for the action to run.","title":"Column Condition"},{"type":"object","required":["type","cond","value"],"properties":{"type":{"type":"string","enum":["constant"]},"cond":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["In"]}],"description":"The comparison operator applied to `value`. Either `=` for equality, or `In` for membership when the triggering control is a list."},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"Condition that compares the control's value to a constant. Only valid on a control-sourced trigger.","title":"Constant Condition"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The boolean formula that determines whether the action sequence runs."}},"description":"Boolean formula evaluated using values from the trigger context.","title":"Formula Condition"}],"description":"The condition that selects this branch."},"effects":{"type":"array","items":{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},"description":"Effects that run when this branch is selected."}}},"description":"Additional branches, evaluated in order if `if` does not match."},"else":{"type":"object","required":["effects"],"properties":{"effects":{"type":"array","items":{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},"description":"Effects that run when no branch condition matches."}},"description":"Runs when no branch condition matches."}}}],"description":"Runs different effects depending on a condition.","title":"If/Else"}]},"description":"The effects that run when the trigger occurs."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for the action."},"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the action runs. Defaults to `enabled`."},"successToast":{"allOf":[{"type":"object","required":["showMessage"],"properties":{"showMessage":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the `message` line renders below the title of the action success message."}}},{"type":"object","properties":{"title":{"type":"string","description":"The title of the action success message. Supports dynamic `{{formula}}` text."},"message":{"type":"string","description":"The message displayed to the user when the action completes successfully."}}}],"description":"The message shown after this action runs successfully."},"summary":{"type":"string","description":"A description of what this action sequence does."}}}]}},"UpdateWorkbookSpec":{"allOf":[{"type":"object","required":["document"],"properties":{"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the workbook."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["workbook"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages of the workbook."}}},{"type":"object","required":["elements"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/WorkbookElement"},"description":"The elements in this workbook and their definitions."}}},{"type":"object","properties":{"overlays":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the modal page."},"type":{"type":"string","enum":["modal"],"description":"Marks this page as a modal."},"name":{"type":"string","description":"The name of the modal."}}},{"type":"object","properties":{"modal":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"footer":{"type":"object","properties":{"primaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The primary footer button."},"secondaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The secondary footer button."}},"description":"The footer with primary and secondary buttons."}}}],"description":"The modal presentation options, including width, header, and footer buttons."},"singleRowContainer":{"allOf":[{"type":"object","required":["source","keyColumnId"],"properties":{"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source that supplies the displayed row."},"keyColumnId":{"type":"string","description":"The ID of the source column that identifies which row is displayed. Must be a column declared on the source."}}},{"type":"object","properties":{"keyColumnValue":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The key-column value of the row to display. Must match the key column type. Omit to pin no row."}}}],"description":"Pins the modal to one row of a source: the elements inside it show that row. Omit for an ordinary modal."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions on the modal. Each action's `trigger` must be one of `on-primary-cta-click`, `on-secondary-cta-click`, or `on-close`."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The background image for the modal. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Modal"},{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the drawer page."},"type":{"type":"string","enum":["drawer"],"description":"Marks this page as a drawer."},"name":{"type":"string","description":"The name of the drawer."}}},{"type":"object","properties":{"drawer":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"showShadow":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to display the drawer as a page overlay, dimming the page behind it when open. Either `shown` to dim the background page or `hidden` for none."}}}],"description":"The presentation of the drawer, including width, header, and page overlay."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by the drawer, on close."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"Background image for the drawer. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Drawer"},{"allOf":[{"type":"object","required":["id","type","name","popover"],"properties":{"id":{"type":"string","description":"The identifier of the popover page."},"type":{"type":"string","enum":["popover"],"description":"Marks this page as a popover."},"name":{"type":"string","description":"The name of the popover."},"popover":{"allOf":[{"type":"object","required":["triggerElementId"],"properties":{"triggerElementId":{"type":"string","description":"The identifier of the button that triggers the popover."}}},{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"Popover width breakpoint: x-small, small, medium, large, or x-large."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"padding":{"type":"string","enum":["none"],"description":"Set to 'none' to remove padding from the popover."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Gap between popover elements: 'shown' (default) or 'hidden'."}}}],"description":"Popover presentation: trigger button, width, spacing, padding, and element gap."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions fired by the popover when it closes."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Popover"}]},"description":"The modals, drawers, and popovers in this workbook and their contents."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page header."},"type":{"type":"string","enum":["header"],"description":"Identifies this panel as a page header."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the header."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["shadow"]},{"type":"string","enum":["none"]}],"description":"The border drawn below the header. One of `line`, `shadow`, or `none`. `shadow` applies only when `scroll` is `sticky`."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The header presentation, including scroll behavior, border, background, and height."}}}],"title":"PageHeader"},{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page sidebar."},"type":{"type":"string","enum":["sidebar"],"description":"Identifies this panel as a page sidebar."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the sidebar."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"width":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Sidebar width preset. One of `small` (200px), `medium` (260px), or `large` (400px). Defaults to `medium`."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["none"]}],"description":"The border style for the sidebar."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The sidebar presentation, including scroll behavior, border, and background color."}}}],"title":"PageSidebar"}]},"description":"The definitions of page headers and sidebars in this document."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}},{"type":"object","properties":{"agents":{"type":"array","items":{"allOf":[{"type":"object","required":["id","instructions"],"properties":{"id":{"type":"string","description":"The identifier of the agent."},"instructions":{"type":"string","description":"Instructions that guide the agent. Use `{{formula}}` for dynamic values, `@dataSource(\"elementId\")` for configured data sources, and `@tool(\"toolId\")` for configured tools."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the agent."},"description":{"type":"string","description":"The description of the agent."},"greeting":{"oneOf":[{"type":"object","required":["mode","message"],"properties":{"mode":{"type":"string","enum":["static"]},"message":{"type":"string","description":"The first message an agent displays when the chat opens. Not generated by the AI provider. Supports dynamic `{{formula}}` text."}},"description":"","title":"Fixed greeting"},{"type":"object","required":["mode","prompt"],"properties":{"mode":{"type":"string","enum":["generated"]},"prompt":{"type":"string","description":"The prompt the agent uses to generate the first message displayed when the chat opens. Supports dynamic `{{formula}}` text."}},"description":"","title":"Generated greeting"}],"description":"The greeting message for the agent. Set `mode` to `static` with a `message`, or `generated` with a `prompt`. Omit for the product default."},"dataSources":{"type":"array","items":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of a workbook element, such as a table or chart, the agent can read from."}},"description":"","title":"Workbook element"},"description":"The data elements or data model tables the agent can access."},"tools":{"type":"array","items":{"oneOf":[{"type":"object","required":["toolId","kind","connectorId","name"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["mcp-connector"]},"connectorId":{"type":"string","description":"The UUID of the MCP connector."},"name":{"type":"string","description":"The display name of the MCP connector."}},"description":"","title":"MCP connector"},{"allOf":[{"type":"object","required":["toolId","kind"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["warehouse-agent"]}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of when the agent should invoke this warehouse agent."}}}],"description":"","title":"Warehouse agent"},{"allOf":[{"type":"object","required":["toolId","kind","description"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["search-service"]},"description":{"type":"string","description":"A description of what this search service can retrieve, used by the agent to decide when to call it."}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}}],"description":"","title":"Search service"},{"allOf":[{"type":"object","required":["toolId","kind","name","description","steps"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["action"]},"name":{"type":"string","description":"The display name of the action tool."},"description":{"type":"string","description":"A description of what this tool does and when the agent should invoke it."},"steps":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["kind","sequenceId"],"properties":{"kind":{"type":"string","enum":["sequence"]},"sequenceId":{"type":"string","description":"The identifier of an action sequence in the workbook."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"","title":"Sequence reference"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["effect"]}}},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"An action effect to run. Effects that depend on user interaction, such as a selected row or column, are not supported.","title":"Inline effect"}]},"description":"The steps the agent runs when it invokes this action tool."}}},{"type":"object","properties":{"requiresApproval":{"type":"boolean","description":"Whether the agent must pause to get user approval before running this tool. Defaults to `false`."}}}],"description":"","title":"Action"}]},"description":"The tools the agent can invoke to take action or enrich insights."}}}]},"description":"The agents defined in the workbook. Reference one from a chat element using `agentId`."}}},{"type":"object","properties":{"automatedActions":{"type":"array","items":{"allOf":[{"type":"object","required":["effects","id","schedule","trigger"],"properties":{"effects":{"type":"array","items":{"allOf":[{"type":"object","required":["agentId","effect","prompt"],"properties":{"agentId":{"type":"string","description":"The identifier of the Sigma agent to run in this workbook."},"effect":{"type":"string","enum":["call-agent"]},"prompt":{"type":"string","description":"The instructions passed to the agent when the action runs."}}},{"type":"object","properties":{"actionVariables":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the action variable for the agent to return the value from."},"type":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["integer"]},{"type":"string","enum":["boolean"]},{"type":"string","enum":["datetime"]}],"description":"Scalar data type of the action variable."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the action variable."}}}]},"description":"The action variables populated from the agent response."}}}]},"description":"The actions that run when the schedule triggers."},"id":{"type":"string","description":"The stable identifier for this automated action sequence."},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"The cron expression that determines when the scheduled action runs. E.g., `0 9 * * 1` runs every Monday at 9:00 AM."},"timezone":{"type":"string","description":"The IANA timezone used to evaluate the cron expression."}},"description":"The configuration of a recurring schedule. Includes a cron expression and timezone."},"trigger":{"type":"string","enum":["schedule"],"description":"Runs the automated action sequence on a recurring schedule."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for the automated action sequence."},"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the automated action sequence is turned on or off."}}}]},"description":"The action sequences that run automatically on a schedule or webhook trigger."}}}]},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["workbook"],"description":"Document kind. Always `workbook` for this resource."}}}]},{"type":"object","required":["layout"],"properties":{"layout":{"type":"string","description":"Grid layout as XML.","title":"Layout XML"}}}],"description":"The code representation of the workbook to write: its pages, elements, columns, sources, layout, and theme.","title":"Workbook Document"}}},{"type":"object","properties":{"documentVersion":{"type":"number","description":"When provided, update only if the workbook is still at this document version."}}}]},"DataTypes":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}},"description":"","title":"Null"},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean","description":"Set data value"}},"description":"","title":"Boolean"},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number","description":"Set data value"}},"description":"","title":"Number"},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string","description":"Set data value"}},"description":"","title":"String"},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string","description":"Set data value"}},"description":"","title":"Integer"},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string","description":"Set data value"}},"description":"","title":"DateTime"},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string","description":"Set data value"}},"description":"","title":"Error"},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DataTypes"},"description":"Set data value"}},"description":"","title":"Record"},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}},"description":"","title":"Variant"},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}},"description":"","title":"Array"}],"description":"Set a constant value for condition"},"DataModelSpec":{"allOf":[{"type":"object","required":["dataModelId"],"properties":{"dataModelId":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"}}},{"type":"object","required":["name","url","documentVersion","latestDocumentVersion","ownerId","folderId","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"name":{"type":"string","description":"The name of the data model."},"url":{"type":"string","description":"The full URL for the requested document version of the data model."},"documentVersion":{"type":"number","description":"The document version of the data model."},"latestDocumentVersion":{"type":"number","description":"The most recently published document version of the data model."},"ownerId":{"type":"string","description":"The identifier of the user who owns the data model."},"folderId":{"type":"string","description":"The identifier of the folder in which the data model is located."},"createdBy":{"type":"string","description":"The identifier of the user who created the data model."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated the data model."},"createdAt":{"type":"string","format":"date-time","description":"When the data model was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the data model was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the data model."}}},{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the data model."}}},{"allOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["data-model"],"description":"Document kind. Informational field, ignored when creating or updating a document."}}},{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"type":"object","required":["id","name","elements"],"properties":{"id":{"type":"string","description":"The identifier of the page in the data model."},"name":{"type":"string","description":"The name of the page."},"elements":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","kind","columns","source"],"properties":{"id":{"type":"string","description":"The identifier of the table."},"kind":{"type":"string","enum":["table"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The reference or calculation for the column."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Indicates whether or not the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]},"description":"The columns of the table and their formulas."},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"}],"description":"The source of the table."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the table."},"description":{"type":"string","description":"The description of the table."},"metrics":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the metric."},"formula":{"type":"string","description":"The formula defining the metric."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the metric."},"description":{"type":"string","description":"The description of the metric."},"isHighlighted":{"type":"boolean","description":"Indicates whether or not the metric is highlighted."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."},"timeline":{"allOf":[{"type":"object","required":["dateColumnId"],"properties":{"dateColumnId":{"type":"string","description":"The column of date data used to create the metric timeline."}}},{"type":"object","properties":{"truncation":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The precision to truncate the date to."},"comparison":{"allOf":[{"type":"object","required":["comparisonPeriod"],"properties":{"comparisonPeriod":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time period to compare the current metric value against."}}},{"type":"object","properties":{"direction":{"oneOf":[{"type":"string","enum":["higher-is-better"]},{"type":"string","enum":["lower-is-better"]}],"description":"Indicates whether higher or lower comparison values are better for that metric."}}}],"description":"The time period to compare the current metric value against."}}}],"description":"The timeline configuration for the metric."}}}]},"description":"The metrics associated with this table and their configurations."},"metricFolders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the metric folder."},"name":{"type":"string","description":"The name of the metric folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The metric and sub-folder IDs contained within the folder, in display order."}}}]},"description":"The metric folders in the table and their contents."},"metricOrder":{"type":"array","items":{"type":"string"},"description":"A list of metric and metric-folder identifiers that determines display order."},"relationships":{"type":"array","items":{"allOf":[{"type":"object","required":["id","targetElementId","keys"],"properties":{"id":{"type":"string","description":"The identifier of the relationship."},"targetElementId":{"type":"string","description":"The identifier of the table joined to the parent table in the relationship."},"keys":{"type":"array","items":{"type":"object","required":["sourceColumnId","targetColumnId"],"properties":{"sourceColumnId":{"type":"string","description":"The column from the parent table joined in this relationship."},"targetColumnId":{"type":"string","description":"The column from the target table joined in this relationship."}}},"description":"The pairs of source and target column IDs joined in this relationship."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the relationship."},"description":{"type":"string","description":"The description of the relationship."},"relationshipType":{"oneOf":[{"type":"string","enum":["1:1"]},{"type":"string","enum":["1:N"]},{"type":"string","enum":["N:1"]}],"description":"[Private beta] The cardinality of the relationship."}}}]},"description":"The relationships sourced from this table and their targets."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Indicates whether or not the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this table and their configurations."},"folders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the folder."},"name":{"type":"string","description":"The name of the folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The column and folder IDs contained within the folder."}}}]},"description":"The folders in the table and their contents."},"groupings":{"type":"array","items":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the grouping."}}},{"type":"object","properties":{"groupBy":{"type":"array","items":{"type":"string"},"description":"The columns or folders that define the grouping."},"calculations":{"type":"array","items":{"type":"string"},"description":"The calculations applied to the grouping."}}}]},"description":"The groupings in the table and their contents."},"summary":{"type":"array","items":{"type":"string"},"description":"The identifiers of all columns in the table that are summaries."},"order":{"type":"array","items":{"type":"string"},"description":"A list of identifiers that determines the order in which columns and folders are displayed in the UI. Does not include summary columns."},"visibleAsSource":{"type":"boolean","description":"Indicates whether or not the table can be used as a source in other documents."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The direction in which to sort."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"Indicates how the sort order treats null values."}}}]},"description":"The column, direction, and null behavior used to sort the rows of this table."},"columnSecurities":{"type":"array","items":{"type":"object","required":["id","restrictedColumns","criteria"],"properties":{"id":{"type":"string","description":"The identifier of the column security rule."},"restrictedColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns restricted by the column security rule."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"description":"","title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"description":"","title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"description":"","title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"description":"","title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"description":"","title":"User Attribute"}]}}},"description":"A list of the column security rules applied to columns in this table."},"uniqueKeys":{"type":"array","items":{"type":"string"},"description":"[Private beta] The identifiers of the columns that uniquely identify records in the table."}}}],"description":"","title":"Table"},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["checkbox"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Checkbox"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["switch"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Switch"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."},"showOperators":{"type":"boolean","description":"Indicates whether or not to display the control mode in the UI."},"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text-area"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text Area"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter numbers."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number entered in the control."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Number"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter dates."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The date selected in the control, in ISO 8601 or relative format."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}],"description":"","title":"Date Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["top-n"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","required":["source"],"properties":{"source":{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]},{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","properties":{"source":{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]}],"description":"","title":"List values"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["segmented"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"clearLabel":{"type":"string","description":"The text displayed for the clear option if showClearLabel is true."},"showClearLabel":{"type":"boolean","description":"Indicates whether or not to include a clear option in the control."},"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}],"description":"","title":"Manual"},{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"","title":"Source"}],"description":"The source of the possible values in the control."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}],"description":"","title":"Segmented Control"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"source":{"type":"object","required":["source","columnId"],"properties":{"source":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},"columnId":{"type":"string"}}},"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}}],"description":"","title":"Hierarchy"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The comparison operator used by the control."}}},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number selected in the control."}}}],"description":"","title":"Slider"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["range-slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Range Slider"}],"description":"","title":"Control"}]},"description":"The elements on the page."}}},"description":"The pages of the data model and their contents."}}}]}]}]},"CreateDataModelSpec":{"allOf":[{"type":"object","required":["name","folderId"],"properties":{"name":{"type":"string","description":"The name of the data model."},"folderId":{"type":"string","description":"The identifier of the folder in which the data model is located."}}},{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the data model."}}},{"allOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["data-model"],"description":"Document kind. Informational field, ignored when creating or updating a document."}}},{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"type":"object","required":["id","name","elements"],"properties":{"id":{"type":"string","description":"The identifier of the page in the data model."},"name":{"type":"string","description":"The name of the page."},"elements":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","kind","columns","source"],"properties":{"id":{"type":"string","description":"The identifier of the table."},"kind":{"type":"string","enum":["table"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The reference or calculation for the column."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Indicates whether or not the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]},"description":"The columns of the table and their formulas."},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"}],"description":"The source of the table."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the table."},"description":{"type":"string","description":"The description of the table."},"metrics":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the metric."},"formula":{"type":"string","description":"The formula defining the metric."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the metric."},"description":{"type":"string","description":"The description of the metric."},"isHighlighted":{"type":"boolean","description":"Indicates whether or not the metric is highlighted."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."},"timeline":{"allOf":[{"type":"object","required":["dateColumnId"],"properties":{"dateColumnId":{"type":"string","description":"The column of date data used to create the metric timeline."}}},{"type":"object","properties":{"truncation":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The precision to truncate the date to."},"comparison":{"allOf":[{"type":"object","required":["comparisonPeriod"],"properties":{"comparisonPeriod":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time period to compare the current metric value against."}}},{"type":"object","properties":{"direction":{"oneOf":[{"type":"string","enum":["higher-is-better"]},{"type":"string","enum":["lower-is-better"]}],"description":"Indicates whether higher or lower comparison values are better for that metric."}}}],"description":"The time period to compare the current metric value against."}}}],"description":"The timeline configuration for the metric."}}}]},"description":"The metrics associated with this table and their configurations."},"metricFolders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the metric folder."},"name":{"type":"string","description":"The name of the metric folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The metric and sub-folder IDs contained within the folder, in display order."}}}]},"description":"The metric folders in the table and their contents."},"metricOrder":{"type":"array","items":{"type":"string"},"description":"A list of metric and metric-folder identifiers that determines display order."},"relationships":{"type":"array","items":{"allOf":[{"type":"object","required":["id","targetElementId","keys"],"properties":{"id":{"type":"string","description":"The identifier of the relationship."},"targetElementId":{"type":"string","description":"The identifier of the table joined to the parent table in the relationship."},"keys":{"type":"array","items":{"type":"object","required":["sourceColumnId","targetColumnId"],"properties":{"sourceColumnId":{"type":"string","description":"The column from the parent table joined in this relationship."},"targetColumnId":{"type":"string","description":"The column from the target table joined in this relationship."}}},"description":"The pairs of source and target column IDs joined in this relationship."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the relationship."},"description":{"type":"string","description":"The description of the relationship."},"relationshipType":{"oneOf":[{"type":"string","enum":["1:1"]},{"type":"string","enum":["1:N"]},{"type":"string","enum":["N:1"]}],"description":"[Private beta] The cardinality of the relationship."}}}]},"description":"The relationships sourced from this table and their targets."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Indicates whether or not the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this table and their configurations."},"folders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the folder."},"name":{"type":"string","description":"The name of the folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The column and folder IDs contained within the folder."}}}]},"description":"The folders in the table and their contents."},"groupings":{"type":"array","items":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the grouping."}}},{"type":"object","properties":{"groupBy":{"type":"array","items":{"type":"string"},"description":"The columns or folders that define the grouping."},"calculations":{"type":"array","items":{"type":"string"},"description":"The calculations applied to the grouping."}}}]},"description":"The groupings in the table and their contents."},"summary":{"type":"array","items":{"type":"string"},"description":"The identifiers of all columns in the table that are summaries."},"order":{"type":"array","items":{"type":"string"},"description":"A list of identifiers that determines the order in which columns and folders are displayed in the UI. Does not include summary columns."},"visibleAsSource":{"type":"boolean","description":"Indicates whether or not the table can be used as a source in other documents."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The direction in which to sort."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"Indicates how the sort order treats null values."}}}]},"description":"The column, direction, and null behavior used to sort the rows of this table."},"columnSecurities":{"type":"array","items":{"type":"object","required":["id","restrictedColumns","criteria"],"properties":{"id":{"type":"string","description":"The identifier of the column security rule."},"restrictedColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns restricted by the column security rule."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"description":"","title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"description":"","title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"description":"","title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"description":"","title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"description":"","title":"User Attribute"}]}}},"description":"A list of the column security rules applied to columns in this table."},"uniqueKeys":{"type":"array","items":{"type":"string"},"description":"[Private beta] The identifiers of the columns that uniquely identify records in the table."}}}],"description":"","title":"Table"},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["checkbox"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Checkbox"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["switch"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Switch"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."},"showOperators":{"type":"boolean","description":"Indicates whether or not to display the control mode in the UI."},"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text-area"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text Area"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter numbers."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number entered in the control."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Number"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter dates."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The date selected in the control, in ISO 8601 or relative format."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}],"description":"","title":"Date Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["top-n"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","required":["source"],"properties":{"source":{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]},{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","properties":{"source":{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]}],"description":"","title":"List values"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["segmented"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"clearLabel":{"type":"string","description":"The text displayed for the clear option if showClearLabel is true."},"showClearLabel":{"type":"boolean","description":"Indicates whether or not to include a clear option in the control."},"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}],"description":"","title":"Manual"},{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"","title":"Source"}],"description":"The source of the possible values in the control."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}],"description":"","title":"Segmented Control"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"source":{"type":"object","required":["source","columnId"],"properties":{"source":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},"columnId":{"type":"string"}}},"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}}],"description":"","title":"Hierarchy"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The comparison operator used by the control."}}},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number selected in the control."}}}],"description":"","title":"Slider"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["range-slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Range Slider"}],"description":"","title":"Control"}]},"description":"The elements on the page."}}},"description":"The pages of the data model and their contents."}}}]}]},{"type":"object","properties":{"description":{"type":"string","description":"The description of the data model."}}}]},"UpdateDataModelSpec":{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the data model."}}},{"allOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["data-model"],"description":"Document kind. Informational field, ignored when creating or updating a document."}}},{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"type":"object","required":["id","name","elements"],"properties":{"id":{"type":"string","description":"The identifier of the page in the data model."},"name":{"type":"string","description":"The name of the page."},"elements":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","kind","columns","source"],"properties":{"id":{"type":"string","description":"The identifier of the table."},"kind":{"type":"string","enum":["table"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The reference or calculation for the column."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Indicates whether or not the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]},"description":"The columns of the table and their formulas."},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"}],"description":"The source of the table."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the table."},"description":{"type":"string","description":"The description of the table."},"metrics":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the metric."},"formula":{"type":"string","description":"The formula defining the metric."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the metric."},"description":{"type":"string","description":"The description of the metric."},"isHighlighted":{"type":"boolean","description":"Indicates whether or not the metric is highlighted."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."},"timeline":{"allOf":[{"type":"object","required":["dateColumnId"],"properties":{"dateColumnId":{"type":"string","description":"The column of date data used to create the metric timeline."}}},{"type":"object","properties":{"truncation":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The precision to truncate the date to."},"comparison":{"allOf":[{"type":"object","required":["comparisonPeriod"],"properties":{"comparisonPeriod":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time period to compare the current metric value against."}}},{"type":"object","properties":{"direction":{"oneOf":[{"type":"string","enum":["higher-is-better"]},{"type":"string","enum":["lower-is-better"]}],"description":"Indicates whether higher or lower comparison values are better for that metric."}}}],"description":"The time period to compare the current metric value against."}}}],"description":"The timeline configuration for the metric."}}}]},"description":"The metrics associated with this table and their configurations."},"metricFolders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the metric folder."},"name":{"type":"string","description":"The name of the metric folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The metric and sub-folder IDs contained within the folder, in display order."}}}]},"description":"The metric folders in the table and their contents."},"metricOrder":{"type":"array","items":{"type":"string"},"description":"A list of metric and metric-folder identifiers that determines display order."},"relationships":{"type":"array","items":{"allOf":[{"type":"object","required":["id","targetElementId","keys"],"properties":{"id":{"type":"string","description":"The identifier of the relationship."},"targetElementId":{"type":"string","description":"The identifier of the table joined to the parent table in the relationship."},"keys":{"type":"array","items":{"type":"object","required":["sourceColumnId","targetColumnId"],"properties":{"sourceColumnId":{"type":"string","description":"The column from the parent table joined in this relationship."},"targetColumnId":{"type":"string","description":"The column from the target table joined in this relationship."}}},"description":"The pairs of source and target column IDs joined in this relationship."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the relationship."},"description":{"type":"string","description":"The description of the relationship."},"relationshipType":{"oneOf":[{"type":"string","enum":["1:1"]},{"type":"string","enum":["1:N"]},{"type":"string","enum":["N:1"]}],"description":"[Private beta] The cardinality of the relationship."}}}]},"description":"The relationships sourced from this table and their targets."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Indicates whether or not the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this table and their configurations."},"folders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the folder."},"name":{"type":"string","description":"The name of the folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The column and folder IDs contained within the folder."}}}]},"description":"The folders in the table and their contents."},"groupings":{"type":"array","items":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the grouping."}}},{"type":"object","properties":{"groupBy":{"type":"array","items":{"type":"string"},"description":"The columns or folders that define the grouping."},"calculations":{"type":"array","items":{"type":"string"},"description":"The calculations applied to the grouping."}}}]},"description":"The groupings in the table and their contents."},"summary":{"type":"array","items":{"type":"string"},"description":"The identifiers of all columns in the table that are summaries."},"order":{"type":"array","items":{"type":"string"},"description":"A list of identifiers that determines the order in which columns and folders are displayed in the UI. Does not include summary columns."},"visibleAsSource":{"type":"boolean","description":"Indicates whether or not the table can be used as a source in other documents."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The direction in which to sort."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"Indicates how the sort order treats null values."}}}]},"description":"The column, direction, and null behavior used to sort the rows of this table."},"columnSecurities":{"type":"array","items":{"type":"object","required":["id","restrictedColumns","criteria"],"properties":{"id":{"type":"string","description":"The identifier of the column security rule."},"restrictedColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns restricted by the column security rule."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"description":"","title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"description":"","title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"description":"","title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"description":"","title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"description":"","title":"User Attribute"}]}}},"description":"A list of the column security rules applied to columns in this table."},"uniqueKeys":{"type":"array","items":{"type":"string"},"description":"[Private beta] The identifiers of the columns that uniquely identify records in the table."}}}],"description":"","title":"Table"},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["checkbox"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Checkbox"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["switch"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Switch"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."},"showOperators":{"type":"boolean","description":"Indicates whether or not to display the control mode in the UI."},"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text-area"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text Area"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter numbers."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number entered in the control."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Number"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter dates."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The date selected in the control, in ISO 8601 or relative format."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}],"description":"","title":"Date Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["top-n"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","required":["source"],"properties":{"source":{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]},{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","properties":{"source":{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]}],"description":"","title":"List values"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["segmented"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"clearLabel":{"type":"string","description":"The text displayed for the clear option if showClearLabel is true."},"showClearLabel":{"type":"boolean","description":"Indicates whether or not to include a clear option in the control."},"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}],"description":"","title":"Manual"},{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"","title":"Source"}],"description":"The source of the possible values in the control."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}],"description":"","title":"Segmented Control"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"source":{"type":"object","required":["source","columnId"],"properties":{"source":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},"columnId":{"type":"string"}}},"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}}],"description":"","title":"Hierarchy"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The comparison operator used by the control."}}},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number selected in the control."}}}],"description":"","title":"Slider"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["range-slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Range Slider"}],"description":"","title":"Control"}]},"description":"The elements on the page."}}},"description":"The pages of the data model and their contents."}}}]}]},{"type":"object","properties":{"documentVersion":{"type":"number","description":"When provided, update only if the data model is still at this document version."}}}]},"ParamShapeNode":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"string","enum":["string"]}}}},{"type":"object","required":["type"],"properties":{"type":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"string","enum":["number"]}}}},{"type":"object","required":["type"],"properties":{"type":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"string","enum":["boolean"]}}}},{"type":"object","required":["type","properties"],"properties":{"type":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"string","enum":["object"]}},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ParamShapeNode"}}}},{"type":"object","required":["type","items"],"properties":{"type":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"string","enum":["array"]}},"items":{"$ref":"#/components/schemas/ParamShapeNode"}}},{"type":"object","required":[],"properties":{}}]},"AiEmbeddedModel":{"oneOf":[{"$ref":"#/components/schemas/AiSnowflakeEmbeddedModel"},{"$ref":"#/components/schemas/AiBigQueryEmbeddedModel"},{"$ref":"#/components/schemas/AiDatabricksEmbeddedModel"},{"$ref":"#/components/schemas/AiOpenAiEmbeddedModel"},{"$ref":"#/components/schemas/AiGeminiEmbeddedModel"}]},"AiSnowflakeEmbeddedModel":{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["snowflake"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}}},"AiBigQueryEmbeddedModel":{"allOf":[{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["bigquery"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}}},{"type":"object","properties":{"region":{"type":"string","description":"For a BigQuery connection, Vertex AI location for the project. Defaults to `us-central1`."}}}]},"AiDatabricksEmbeddedModel":{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["databricks"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}}},"AiOpenAiEmbeddedModel":{"type":"object","required":["provider","apiKey"],"properties":{"provider":{"type":"string","enum":["openAI"],"description":""},"apiKey":{"type":"string","description":"OpenAI API key."}}},"AiGeminiEmbeddedModel":{"type":"object","required":["provider","apiKey"],"properties":{"provider":{"type":"string","enum":["gemini"],"description":""},"apiKey":{"type":"string","description":"Gemini API key."}}},"AiAzureEmbeddedModel":{"allOf":[{"type":"object","required":["provider"],"properties":{"provider":{"type":"string","enum":["azureOpenAI"],"description":""}}},{"type":"object","required":["deploymentId","endpointURL","apiKey"],"properties":{"deploymentId":{"type":"string","description":"Azure OpenAI deployment ID."},"endpointURL":{"type":"string","description":"Azure OpenAI endpoint URL."},"apiKey":{"type":"string","description":"Azure OpenAI API key."}}}]},"AiEmbeddedModelRes":{"oneOf":[{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["snowflake"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}},"description":"","title":"Snowflake"},{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["bigquery"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}},"description":"","title":"BigQuery"},{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["databricks"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}},"description":"","title":"Databricks"},{"type":"object","required":["provider"],"properties":{"provider":{"type":"string","enum":["openAI"],"description":""}},"description":"","title":"OpenAI"},{"type":"object","required":["provider"],"properties":{"provider":{"type":"string","enum":["gemini"],"description":""}},"description":"","title":"Gemini"}]},"CommonElement":{"oneOf":[{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/Table"}],"title":"Table"},{"allOf":[{"type":"object","required":["id","kind","source","columns","value"],"properties":{"id":{"type":"string","description":"The identifier of the KPI."},"kind":{"type":"string","enum":["kpi-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the KPI."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns that calculate the KPI's value and optional comparison."},"value":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column that specifies the KPI value."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the KPI value number is shown. Set to `hidden` to hide it. Only applies when a comparison is configured."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the value."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size of the value, in pixels. Defaults to `auto`."}}}],"description":"The column used for the KPI's primary value, plus optional styling."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The title font size in pixels, or `auto` to size automatically."}}}],"title":"Shown title"}],"description":"Display name for the KPI. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size of the description, in pixels. Specify `auto` to size it automatically."}},"description":"The description of the KPI and its styling."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"layout":{"type":"object","properties":{"anchor":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the KPI within its container."},"verticalAnchor":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment."},"titleOrient":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["bottom"]}],"description":"The title position relative to the KPI value. Defaults to `top`."},"comparisonValueOrient":{"oneOf":[{"type":"string","enum":["right"]},{"type":"string","enum":["below"]}],"description":"The comparison value position."}},"description":"The alignment, title position, and comparison position for the KPI."},"comparison":{"type":"object","properties":{"display":{"oneOf":[{"type":"string","enum":["percentage"]},{"type":"string","enum":["delta"]},{"type":"string","enum":["relative"]},{"type":"string","enum":["absolute"]}],"description":"The display format for the comparison. Defaults to `percentage`."},"direction":{"oneOf":[{"type":"string","enum":["higher"]},{"type":"string","enum":["lower"]},{"type":"string","enum":["none"]}],"description":"The comparison direction. One of `higher` (higher is better), `lower` (lower is better), or `none`."},"colorGood":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"colorNeutral":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"colorBad":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"arrow":{"type":"string","enum":["hidden"],"description":"Hide the comparison arrow. Omit when shown."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The comparison font size in pixels, or `auto`."},"label":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"string"}],"description":"The comparison label text. Set to `hidden` to hide the label."},"labelColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"noDateText":{"type":"string","description":"The label shown when the comparison date is invalid. Defaults to `Invalid date`."}},"description":"The comparison formatting for the KPI."},"trend":{"type":"object","properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the trend sparkline. Omit to show."},"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["area"]}],"description":"The trend shape. Defaults to `line` when a comparison is configured, otherwise `area`."},"areaStyle":{"oneOf":[{"type":"string","enum":["gradient"]},{"type":"string","enum":["solid"]}],"description":"The area fill style for the trend line. Only applies when shape is `area`."},"valueColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"comparisonColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"tooltip":{"type":"string","enum":["shown"],"description":"Set to `shown` to explicitly enable a feature whose default is off."},"xAxis":{"type":"string","enum":["shown"],"description":"Set to `shown` to explicitly enable a feature whose default is off."},"yAxis":{"type":"string","enum":["shown"],"description":"Set to `shown` to explicitly enable a feature whose default is off."},"noDataText":{"type":"string","description":"Label shown when the trend has no data."}},"description":"The sparkline display options for the KPI chart."},"timeline":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The date or time column that defines the timeline for the trend sparkline."}},"description":"The date column on the KPI timeline, enabling the trend sparkline. Set `columnId` to a column declared on the chart. Required by `periodComparison`."},"periodComparison":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The period used for a period-over-period comparison. Requires a timeline column. Cannot be specified if `comparisonColumn` is specified."},"comparisonColumn":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The identifier of the column used for the KPI comparison."}},"description":"The column to compare the primary value against. Cannot be specified if `periodComparison` is specified."},"conditionalFormats":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","formula"],"properties":{"condition":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula for a conditional formatting rule. Can reference any column in the element. Must return a boolean."}}}]}]},{"type":"object","properties":{"style":{"type":"object","properties":{"color":{"type":"string","description":"The font color, as a hex code."}}}}}]},"description":"Single-color conditional formatting rules applied to the KPI value. Order matters; only the first matching rule applies."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"KPI"},{"allOf":[{"type":"object","required":["id","kind","source","columns","yAxis"],"properties":{"id":{"type":"string","description":"The identifier of the bar chart."},"kind":{"type":"string","enum":["bar-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the bar chart."},"columns":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},{"type":"object","properties":{"showOnSegments":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether data label segments are shown. Defaults to `hidden`. Requires a stacked bar chart with color by category, color by scale, or multiple y-axis series."},"showOnTotals":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the total data label is shown. Defaults to `shown`. Requires a stacked bar chart with color by category, color by scale, or multiple y-axis series."}}}]},"description":"The columns used by the bar chart."},"yAxis":{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"oneOf":[{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."},{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."}}},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["bar"]},{"type":"string","enum":["line"]},{"type":"string","enum":["area"]},{"type":"string","enum":["scatter"]}],"description":"The chart shape for this series. Defaults to `bar`."}}}]}]},"description":"The column IDs for the Y-axis series. Lists every series on the chart, including those assigned to the secondary axis by `yAxis2`."}}},{"type":"object","properties":{"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The Y-axis formatting, including title, labels, marks, and scale."}}}],"description":"The columns used for the Y-axis."}}},{"type":"object","properties":{"xAxis":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for the X-axis."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."},"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The X-axis formatting, including title, labels, marks, and scale."}}}],"description":"The column used for the X-axis."},"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the chart."},"label":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},"description":"Label encoding — custom data label fields (Marks shelf Label tab). Each id references a column in `columns`. Not the Data labels format section."},"stacking":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["stacked"]},{"type":"string","enum":["normalized"]}],"description":"The stacking mode for the chart. Defaults to `stacked`."},"orientation":{"type":"string","enum":["horizontal"],"description":"Bar orientation. Set to `horizontal` to display horizontal bars. Omit to display vertical bars."},"barStyle":{"type":"object","properties":{"cornerRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The bar corner shape. Defaults to `square`."}},"description":"The bar corner shape. Defaults to `square`."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"conditionalFormats":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","formula"],"properties":{"condition":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula for a conditional formatting rule. Can reference any column in the element. Must return a boolean."}}}]}]},{"type":"object","properties":{"style":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The cell background color, as a hex code."}}}}}]},"description":"Single-color conditional formatting rules applied to chart marks. Order matters; only the first matching rule applies."},"dataLabel":{"type":"object","properties":{"anchor":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["end"]},{"type":"string","enum":["middle"]},{"type":"string","enum":["outside-end"]},{"type":"string","enum":["start"]}],"description":"Position of the data label relative to its mark."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["all"]}],"description":"Which values and labels to show on each bar segment label."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"orient":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"Text direction for data labels."},"precision":{"type":"number","description":"The number of decimal places when labels include percentages."},"showStroke":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["on"]},{"type":"string","enum":["off"]}],"description":"The stroke (outline) around data labels."},"totals":{"type":"object","properties":{"display":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"fontSize":{"type":"number","description":"The font size for total labels, in pixels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["all"]}],"description":"Which aggregate total labels appear on the bars. Defaults to `auto`."},"orient":{"oneOf":[{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"The text direction for total labels."}},"description":"The aggregate total label options for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"Whether numeric values are shown as percentages or as plain numbers."}},"description":"Data label typography, placement, and display options."},"gap":{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The spacing between bars (gap width) within each category group."},"betweenSets":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The size preset for the gap between groups of bars. Requires clustered bar sets, from a color by category or color by scale, or multiple bar series with clustered stacking. Defaults to `auto`."}},"description":"The gap width between bars and between clustered bar sets."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"backgroundImage":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the background image. Supports `{{dynamic-text}}` formula references."}},"description":"The chart background image. The URL supports dynamic `{{formula}}` text."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"refMarks":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","axis","value"],"properties":{"type":{"type":"string","enum":["line"],"description":"A reference line marking a single value on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The position of the reference line on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference line, including style, width, and color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]},{"allOf":[{"type":"object","required":["type","axis","value","endValue"],"properties":{"type":{"type":"string","enum":["band"],"description":"A reference band marking a range between two values on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The start position of the reference band on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."},"endValue":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"Band end position (constant, column aggregation, or formula)."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether a line outlining the reference band is shown. Set to `shown` to display it."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference band line, including style, width, and color."},"fill":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The fill color of the reference band. A hex code, `rgb()` value, or theme reference."}},"description":"The band fill color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]}]},"description":"Reference lines and bands on the chart."},"trellis":{"type":"object","properties":{"columnsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis columns. At most one entry."},"column":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis column."},"row":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis row."},"rowsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis rows. At most one entry."},"series":{"oneOf":[{"type":"string","enum":["row"]},{"type":"string","enum":["column"]}],"description":"Display each series in its own chart, arranged as a row or column of panels. Cannot be specified if `rowsBy` or `columnsBy` is specified. Not supported for every chart kind."},"share":{"type":"object","properties":{"color-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one color legend across the grid or each panel gets its own. Defaults to `shared`."},"size-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Size legend display options for the trellis."},"x-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one category-axis scale or each scales to its own data. Defaults to `shared`. This is the category axis even when chart orientation renders it vertically."},"y-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one series-axis (value) scale or each scales to its own data. Defaults to `shared`. This is the series axis even when chart orientation renders it horizontally."},"y-axis-2":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share the secondary series-axis scale. Defaults to `shared`. Combo charts with a second value axis only."}},"description":"The scales and legends shared across trellis panels."},"tileSize":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["compact"]}],"description":"The size of charts in a trellis grid. Defaults to `auto` for category trellis, `compact` for trellis by series."}},"description":"Trellis configuration for the chart."},"trendlines":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","model"],"properties":{"columnId":{"type":"string","description":"The Y-axis column to fit the trend line to."},"model":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["quadratic"]},{"type":"string","enum":["polynomial"]},{"type":"string","enum":["exponential"]},{"type":"string","enum":["logarithmic"]},{"type":"string","enum":["power"]}],"description":"Regression model for the trend line."}}},{"type":"object","properties":{"degree":{"type":"number","description":"The polynomial order of the regression fit, from 3 to 7. Defaults to `3`. Only applies when `model` is `polynomial`."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The line style, width, and color for the trend line."},"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"value":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"The regression fit value (R²) drawn on the chart. Set `visibility` to `shown`, or omit the block to hide it."},"equation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"Regression equation. Omit the block to hide the equation."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"The position of the label and computed-value annotation for the trend line."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The label and value display options for the trend line."}}}]},"description":"The regression trend lines for the chart. Each trend line applies to a column plotted on the Y-axis."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Bar Chart"},{"oneOf":[{"allOf":[{"type":"object","required":["id","kind","source","columns","color","value"],"properties":{"id":{"type":"string","description":"The identifier of the pie chart."},"kind":{"type":"string","enum":["pie-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the chart."},"color":{"allOf":[{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."}}}]},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}],"description":"The column used to split the donut into slices. Optionally sets a palette scheme and per-value color overrides."},"value":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The column for the slice size."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"dataLabel":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"donutLabelDisplay":{"oneOf":[{"type":"string","enum":["as-label"]},{"type":"string","enum":["on-legend"]}],"description":"Whether donut or pie slice labels appear on the slice or in the legend."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["color"]},{"type":"string","enum":["value"]},{"type":"string","enum":["percent"]},{"type":"string","enum":["color-value"]},{"type":"string","enum":["color-percent"]},{"type":"string","enum":["value-percent"]},{"type":"string","enum":["all"]}],"description":"Which values and labels to show on each slice label."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"precision":{"type":"number","description":"The number of decimal places when labels include percentages."}},"description":"Data label typography, placement, and display options for slice values."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the chart."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}]},{"allOf":[{"type":"object","required":["id","kind","source","columns","color","value"],"properties":{"id":{"type":"string","description":"The identifier of the donut chart."},"kind":{"type":"string","enum":["donut-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the chart."},"color":{"allOf":[{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."}}}]},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}],"description":"The column used to split the donut into slices. Optionally sets a palette scheme and per-value color overrides."},"value":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The column for the slice size."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"dataLabel":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"donutLabelDisplay":{"oneOf":[{"type":"string","enum":["as-label"]},{"type":"string","enum":["on-legend"]}],"description":"Whether donut or pie slice labels appear on the slice or in the legend."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["color"]},{"type":"string","enum":["value"]},{"type":"string","enum":["percent"]},{"type":"string","enum":["color-value"]},{"type":"string","enum":["color-percent"]},{"type":"string","enum":["value-percent"]},{"type":"string","enum":["all"]}],"description":"Which values and labels to show on each slice label."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"precision":{"type":"number","description":"The number of decimal places when labels include percentages."}},"description":"Data label typography, placement, and display options for slice values."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the chart."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."},"holeValue":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"Optional column for the donut hole KPI value."},"hole":{"type":"object","properties":{"value":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the donut hole value is shown. Defaults to `shown`."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"The font size of the donut hole value, in pixels."}}},"title":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the donut hole title is shown. Defaults to `shown`."},"text":{"type":"string","description":"The text of the donut hole title. Cannot be set when the title is hidden."},"wrap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"The text wrap behavior. `shown` wraps to multiple lines, and `hidden` truncates to one line."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"The font size of the donut hole title, in pixels."},"position":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["bottom"]}],"description":"The position of the donut hole title."}}}},"description":"The title and value styling for the donut hole center."},"innerRadius":{"type":"number","description":"Donut hole size as a ratio of the outer radius. Must be between `0.4` and `0.8`. Defaults to `0.6`."},"trellis":{"type":"object","properties":{"columnsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis columns. At most one entry."},"column":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis column."},"row":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis row."},"rowsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis rows. At most one entry."},"series":{"oneOf":[{"type":"string","enum":["row"]},{"type":"string","enum":["column"]}],"description":"Display each series in its own chart, arranged as a row or column of panels. Cannot be specified if `rowsBy` or `columnsBy` is specified. Not supported for every chart kind."},"share":{"type":"object","properties":{"color-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one color legend across the grid or each panel gets its own. Defaults to `shared`."},"size-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Size legend display options for the trellis."},"x-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one category-axis scale or each scales to its own data. Defaults to `shared`. This is the category axis even when chart orientation renders it vertically."},"y-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one series-axis (value) scale or each scales to its own data. Defaults to `shared`. This is the series axis even when chart orientation renders it horizontally."},"y-axis-2":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share the secondary series-axis scale. Defaults to `shared`. Combo charts with a second value axis only."}},"description":"The scales and legends shared across trellis panels."},"tileSize":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["compact"]}],"description":"The size of charts in a trellis grid. Defaults to `auto` for category trellis, `compact` for trellis by series."}},"description":"Trellis configuration for the chart."}}}]}],"description":"","title":"Donut/Pie Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","yAxis"],"properties":{"id":{"type":"string","description":"The identifier of the line chart."},"kind":{"type":"string","enum":["line-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the line chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the line chart."},"yAxis":{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"oneOf":[{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."},{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."}}},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["bar"]},{"type":"string","enum":["line"]},{"type":"string","enum":["area"]},{"type":"string","enum":["scatter"]}],"description":"The chart shape for this series. Defaults to `bar`."}}}]}]},"description":"The column IDs for the Y-axis series. Lists every series on the chart, including those assigned to the secondary axis by `yAxis2`."}}},{"type":"object","properties":{"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The Y-axis formatting, including title, labels, marks, and scale."}}}],"description":"The columns used for the Y-axis."}}},{"type":"object","properties":{"xAxis":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for the X-axis."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."},"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The X-axis formatting, including title, labels, marks, and scale."}}}],"description":"The column used for the X-axis."},"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the chart."},"label":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},"description":"Label encoding — custom data label fields (Marks shelf Label tab). Each id references a column in `columns`. Not the Data labels format section."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"dataLabel":{"type":"object","properties":{"clearance":{"oneOf":[{"type":"string","enum":["separated"]},{"type":"string","enum":["default"]}],"description":"Spacing between data labels and neighboring marks when labels could overlap lines or areas. Either `separated` to offset labels clear of the mark, or `default`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["endpoints"]},{"type":"string","enum":["most-recent"]},{"type":"string","enum":["all-points"]}],"description":"Which values and labels to show on each line point label."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."}},"description":"Data label typography, placement, and display options."},"lineAreaStyle":{"type":"object","properties":{"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the area line is shown. Defaults to `shown` for layered area charts and `hidden` otherwise."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"Line stroke and area outline visibility."},"points":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether points are shown. Defaults to `shown`. `shape` and `size` cannot be set when `hidden`."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}},"description":"The points on the series. Configure shape, size, and visibility."}},"description":"The line interpolation, stroke style, point markers, and null handling for the series."},"backgroundImage":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the background image. Supports `{{dynamic-text}}` formula references."}},"description":"The chart background image. The URL supports dynamic `{{formula}}` text."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"refMarks":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","axis","value"],"properties":{"type":{"type":"string","enum":["line"],"description":"A reference line marking a single value on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The position of the reference line on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference line, including style, width, and color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]},{"allOf":[{"type":"object","required":["type","axis","value","endValue"],"properties":{"type":{"type":"string","enum":["band"],"description":"A reference band marking a range between two values on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The start position of the reference band on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."},"endValue":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"Band end position (constant, column aggregation, or formula)."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether a line outlining the reference band is shown. Set to `shown` to display it."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference band line, including style, width, and color."},"fill":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The fill color of the reference band. A hex code, `rgb()` value, or theme reference."}},"description":"The band fill color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]}]},"description":"Reference lines and bands on the chart."},"trellis":{"type":"object","properties":{"columnsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis columns. At most one entry."},"column":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis column."},"row":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis row."},"rowsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis rows. At most one entry."},"series":{"oneOf":[{"type":"string","enum":["row"]},{"type":"string","enum":["column"]}],"description":"Display each series in its own chart, arranged as a row or column of panels. Cannot be specified if `rowsBy` or `columnsBy` is specified. Not supported for every chart kind."},"share":{"type":"object","properties":{"color-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one color legend across the grid or each panel gets its own. Defaults to `shared`."},"size-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Size legend display options for the trellis."},"x-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one category-axis scale or each scales to its own data. Defaults to `shared`. This is the category axis even when chart orientation renders it vertically."},"y-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one series-axis (value) scale or each scales to its own data. Defaults to `shared`. This is the series axis even when chart orientation renders it horizontally."},"y-axis-2":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share the secondary series-axis scale. Defaults to `shared`. Combo charts with a second value axis only."}},"description":"The scales and legends shared across trellis panels."},"tileSize":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["compact"]}],"description":"The size of charts in a trellis grid. Defaults to `auto` for category trellis, `compact` for trellis by series."}},"description":"Trellis configuration for the chart."},"trendlines":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","model"],"properties":{"columnId":{"type":"string","description":"The Y-axis column to fit the trend line to."},"model":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["quadratic"]},{"type":"string","enum":["polynomial"]},{"type":"string","enum":["exponential"]},{"type":"string","enum":["logarithmic"]},{"type":"string","enum":["power"]}],"description":"Regression model for the trend line."}}},{"type":"object","properties":{"degree":{"type":"number","description":"The polynomial order of the regression fit, from 3 to 7. Defaults to `3`. Only applies when `model` is `polynomial`."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The line style, width, and color for the trend line."},"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"value":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"The regression fit value (R²) drawn on the chart. Set `visibility` to `shown`, or omit the block to hide it."},"equation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"Regression equation. Omit the block to hide the equation."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"The position of the label and computed-value annotation for the trend line."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The label and value display options for the trend line."}}}]},"description":"The regression trend lines for the chart. Each trend line applies to a column plotted on the Y-axis."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Line Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","yAxis"],"properties":{"id":{"type":"string","description":"The identifier of the area chart."},"kind":{"type":"string","enum":["area-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the area chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the area chart."},"yAxis":{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"oneOf":[{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."},{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."}}},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["bar"]},{"type":"string","enum":["line"]},{"type":"string","enum":["area"]},{"type":"string","enum":["scatter"]}],"description":"The chart shape for this series. Defaults to `bar`."}}}]}]},"description":"The column IDs for the Y-axis series. Lists every series on the chart, including those assigned to the secondary axis by `yAxis2`."}}},{"type":"object","properties":{"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The Y-axis formatting, including title, labels, marks, and scale."}}}],"description":"The columns used for the Y-axis."}}},{"type":"object","properties":{"xAxis":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for the X-axis."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."},"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The X-axis formatting, including title, labels, marks, and scale."}}}],"description":"The column used for the X-axis."},"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the chart."},"label":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},"description":"Label encoding — custom data label fields (Marks shelf Label tab). Each id references a column in `columns`. Not the Data labels format section."},"stacking":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["stacked"]},{"type":"string","enum":["normalized"]}],"description":"The stacking mode for the chart. Defaults to `stacked`."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"dataLabel":{"type":"object","properties":{"clearance":{"oneOf":[{"type":"string","enum":["separated"]},{"type":"string","enum":["default"]}],"description":"Spacing between data labels and neighboring marks when labels could overlap lines or areas. Either `separated` to offset labels clear of the mark, or `default`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["endpoints"]},{"type":"string","enum":["most-recent"]},{"type":"string","enum":["all-points"]}],"description":"Which values and labels to show on each area series label."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."}},"description":"Data label typography, placement, and display options."},"lineAreaStyle":{"type":"object","properties":{"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the area line is shown. Defaults to `shown` for layered area charts and `hidden` otherwise."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"Line stroke and area outline visibility."},"points":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether points are shown. Defaults to `shown`. `shape` and `size` cannot be set when `hidden`."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}},"description":"The points on the series. Configure shape, size, and visibility."}},"description":"The styling of the area series, including interpolation, area outline visibility, stroke, points, and null handling."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"backgroundImage":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the background image. Supports `{{dynamic-text}}` formula references."}},"description":"The chart background image. The URL supports dynamic `{{formula}}` text."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"trellis":{"type":"object","properties":{"columnsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis columns. At most one entry."},"column":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis column."},"row":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis row."},"rowsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis rows. At most one entry."},"series":{"oneOf":[{"type":"string","enum":["row"]},{"type":"string","enum":["column"]}],"description":"Display each series in its own chart, arranged as a row or column of panels. Cannot be specified if `rowsBy` or `columnsBy` is specified. Not supported for every chart kind."},"share":{"type":"object","properties":{"color-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one color legend across the grid or each panel gets its own. Defaults to `shared`."},"size-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Size legend display options for the trellis."},"x-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one category-axis scale or each scales to its own data. Defaults to `shared`. This is the category axis even when chart orientation renders it vertically."},"y-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one series-axis (value) scale or each scales to its own data. Defaults to `shared`. This is the series axis even when chart orientation renders it horizontally."},"y-axis-2":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share the secondary series-axis scale. Defaults to `shared`. Combo charts with a second value axis only."}},"description":"The scales and legends shared across trellis panels."},"tileSize":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["compact"]}],"description":"The size of charts in a trellis grid. Defaults to `auto` for category trellis, `compact` for trellis by series."}},"description":"Trellis configuration for the chart."},"trendlines":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","model"],"properties":{"columnId":{"type":"string","description":"The Y-axis column to fit the trend line to."},"model":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["quadratic"]},{"type":"string","enum":["polynomial"]},{"type":"string","enum":["exponential"]},{"type":"string","enum":["logarithmic"]},{"type":"string","enum":["power"]}],"description":"Regression model for the trend line."}}},{"type":"object","properties":{"degree":{"type":"number","description":"The polynomial order of the regression fit, from 3 to 7. Defaults to `3`. Only applies when `model` is `polynomial`."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The line style, width, and color for the trend line."},"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"value":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"The regression fit value (R²) drawn on the chart. Set `visibility` to `shown`, or omit the block to hide it."},"equation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"Regression equation. Omit the block to hide the equation."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"The position of the label and computed-value annotation for the trend line."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The label and value display options for the trend line."}}}]},"description":"The regression trend lines for the chart. Each trend line applies to a column plotted on the Y-axis."},"refMarks":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","axis","value"],"properties":{"type":{"type":"string","enum":["line"],"description":"A reference line marking a single value on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The position of the reference line on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference line, including style, width, and color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]},{"allOf":[{"type":"object","required":["type","axis","value","endValue"],"properties":{"type":{"type":"string","enum":["band"],"description":"A reference band marking a range between two values on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The start position of the reference band on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."},"endValue":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"Band end position (constant, column aggregation, or formula)."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether a line outlining the reference band is shown. Set to `shown` to display it."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference band line, including style, width, and color."},"fill":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The fill color of the reference band. A hex code, `rgb()` value, or theme reference."}},"description":"The band fill color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]}]},"description":"Reference lines and bands on the chart."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Area Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","yAxis"],"properties":{"id":{"type":"string","description":"The identifier of the scatter chart."},"kind":{"type":"string","enum":["scatter-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the scatter chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the scatter chart."},"yAxis":{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"oneOf":[{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."},{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."}}},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["bar"]},{"type":"string","enum":["line"]},{"type":"string","enum":["area"]},{"type":"string","enum":["scatter"]}],"description":"The chart shape for this series. Defaults to `bar`."}}}]}]},"description":"The column IDs for the Y-axis series. Lists every series on the chart, including those assigned to the secondary axis by `yAxis2`."}}},{"type":"object","properties":{"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The Y-axis formatting, including title, labels, marks, and scale."}}}],"description":"The columns used for the Y-axis. Multiple columns create a series-per-column scatter plot."}}},{"type":"object","properties":{"xAxis":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for the X-axis."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."},"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The X-axis formatting, including title, labels, marks, and scale."}}}],"description":"The column used for the X-axis."},"size":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The column whose values determine point size. Each point is sized relative to others in the chart."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"conditionalFormats":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","formula"],"properties":{"condition":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula for a conditional formatting rule. Can reference any column in the element. Must return a boolean."}}}]}]},{"type":"object","properties":{"style":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The cell background color, as a hex code."}}}}}]},"description":"Single-color conditional formatting rules applied to chart marks. Order matters; only the first matching rule applies."},"dataLabel":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"precision":{"type":"number","description":"The number of decimal places when labels use percent format."},"showStroke":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["on"]},{"type":"string","enum":["off"]}],"description":"The stroke (outline) around data labels."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"Whether numeric values are shown as percentages or as plain numbers."}},"description":"Data label typography, placement, and display options."},"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the chart."},"label":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},"description":"Label encoding — custom data label fields (Marks shelf Label tab). Each id references a column in `columns`. Not the Data labels format section."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"backgroundImage":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the background image. Supports `{{dynamic-text}}` formula references."}},"description":"The chart background image. The URL supports dynamic `{{formula}}` text."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"pointStyle":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."},{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The minimum point size applied when a size field is set."}]}},"description":"The point mark shape and size."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"refMarks":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","axis","value"],"properties":{"type":{"type":"string","enum":["line"],"description":"A reference line marking a single value on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The position of the reference line on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference line, including style, width, and color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]},{"allOf":[{"type":"object","required":["type","axis","value","endValue"],"properties":{"type":{"type":"string","enum":["band"],"description":"A reference band marking a range between two values on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The start position of the reference band on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."},"endValue":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"Band end position (constant, column aggregation, or formula)."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether a line outlining the reference band is shown. Set to `shown` to display it."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference band line, including style, width, and color."},"fill":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The fill color of the reference band. A hex code, `rgb()` value, or theme reference."}},"description":"The band fill color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]}]},"description":"Reference lines and bands on the chart."},"trellis":{"type":"object","properties":{"columnsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis columns. At most one entry."},"column":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis column."},"row":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis row."},"rowsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis rows. At most one entry."},"series":{"oneOf":[{"type":"string","enum":["row"]},{"type":"string","enum":["column"]}],"description":"Display each series in its own chart, arranged as a row or column of panels. Cannot be specified if `rowsBy` or `columnsBy` is specified. Not supported for every chart kind."},"share":{"type":"object","properties":{"color-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one color legend across the grid or each panel gets its own. Defaults to `shared`."},"size-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Size legend display options for the trellis."},"x-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one category-axis scale or each scales to its own data. Defaults to `shared`. This is the category axis even when chart orientation renders it vertically."},"y-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one series-axis (value) scale or each scales to its own data. Defaults to `shared`. This is the series axis even when chart orientation renders it horizontally."},"y-axis-2":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share the secondary series-axis scale. Defaults to `shared`. Combo charts with a second value axis only."}},"description":"The scales and legends shared across trellis panels."},"tileSize":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["compact"]}],"description":"The size of charts in a trellis grid. Defaults to `auto` for category trellis, `compact` for trellis by series."}},"description":"Trellis configuration for the chart."},"trendlines":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","model"],"properties":{"columnId":{"type":"string","description":"The Y-axis column to fit the trend line to."},"model":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["quadratic"]},{"type":"string","enum":["polynomial"]},{"type":"string","enum":["exponential"]},{"type":"string","enum":["logarithmic"]},{"type":"string","enum":["power"]}],"description":"Regression model for the trend line."}}},{"type":"object","properties":{"degree":{"type":"number","description":"The polynomial order of the regression fit, from 3 to 7. Defaults to `3`. Only applies when `model` is `polynomial`."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The line style, width, and color for the trend line."},"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"value":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"The regression fit value (R²) drawn on the chart. Set `visibility` to `shown`, or omit the block to hide it."},"equation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"Regression equation. Omit the block to hide the equation."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"The position of the label and computed-value annotation for the trend line."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The label and value display options for the trend line."}}}]},"description":"The regression trend lines for the chart. Each trend line applies to a column plotted on the Y-axis."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Scatter Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","yAxis"],"properties":{"id":{"type":"string","description":"The identifier of the combo chart."},"kind":{"type":"string","enum":["combo-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the combo chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the combo chart."},"yAxis":{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"oneOf":[{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."},{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."}}},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["bar"]},{"type":"string","enum":["line"]},{"type":"string","enum":["area"]},{"type":"string","enum":["scatter"]}],"description":"The chart shape for this series. Defaults to `bar`."}}}]}]},"description":"The column IDs for the Y-axis series. Lists every series on the chart, including those assigned to the secondary axis by `yAxis2`."}}},{"type":"object","properties":{"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The Y-axis formatting, including title, labels, marks, and scale."}}}],"description":"The series plotted on the chart, including any placed on the secondary axis by `yAxis2`. Set `type` to `line`, `area`, or `scatter` to change a series from the default bar."}}},{"type":"object","properties":{"yAxis2":{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string","description":"The identifier of a column for a series on the secondary Y-axis. Must also appear on `yAxis.columnIds`."},"description":"The column IDs for series measured against the secondary Y-axis. Each must also appear on `yAxis.columnIds`. `yAxis2` selects which of the chart's series use the secondary scale, it does not declare new ones. Series shape comes from the `type` on the matching `yAxis` entry."}}},{"type":"object","properties":{"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The secondary Y-axis formatting, including title, labels, scale, and axis mark spacing."}}}],"description":"The secondary Y-axis configuration for combo charts, including which series use it and its formatting."},"xAxis":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for the X-axis."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."},"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The X-axis formatting, including title, labels, marks, and scale."}}}],"description":"The column used for the X-axis."},"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the chart."},"label":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},"description":"Label encoding — custom data label fields (Marks shelf Label tab). Each id references a column in `columns`. Not the Data labels format section."},"stacking":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["stacked"]},{"type":"string","enum":["normalized"]}],"description":"The stacking mode for the chart. Defaults to `stacked`."},"barStyle":{"type":"object","properties":{"cornerRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The bar corner shape. Defaults to `square`."}},"description":"The corner shape for bars in a bar series. Defaults to `square`. Requires at least one bar series on the combo chart."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"conditionalFormats":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","formula"],"properties":{"condition":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula for a conditional formatting rule. Can reference any column in the element. Must return a boolean."}}}]}]},{"type":"object","properties":{"style":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The cell background color, as a hex code."}}}}}]},"description":"Single-color conditional formatting rules applied to chart marks. Order matters; only the first matching rule applies."},"dataLabel":{"type":"object","properties":{"anchor":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["end"]},{"type":"string","enum":["middle"]},{"type":"string","enum":["outside-end"]},{"type":"string","enum":["start"]}],"description":"Position of the data label relative to its mark."},"clearance":{"oneOf":[{"type":"string","enum":["separated"]},{"type":"string","enum":["default"]}],"description":"Spacing between data labels and neighboring marks when labels could overlap lines or areas. Either `separated` to offset labels clear of the mark, or `default`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["all"]},{"type":"string","enum":["all-points"]},{"type":"string","enum":["auto"]},{"type":"string","enum":["color"]},{"type":"string","enum":["color-percent"]},{"type":"string","enum":["color-value"]},{"type":"string","enum":["endpoints"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["most-recent"]},{"type":"string","enum":["percent"]},{"type":"string","enum":["value"]},{"type":"string","enum":["value-percent"]}],"description":"Which values and labels to show on data labels when applying defaults for all series."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"orient":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"Text direction for data labels."},"precision":{"type":"number","description":"The number of decimal places when labels include percentages."},"showStroke":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["on"]},{"type":"string","enum":["off"]}],"description":"The stroke (outline) around data labels."},"totals":{"type":"object","properties":{"display":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"fontSize":{"type":"number","description":"The font size for total labels, in pixels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["all"]}],"description":"Which aggregate total labels appear on the bars. Defaults to `auto`."},"orient":{"oneOf":[{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"The text direction for total labels."}},"description":"The aggregate total label options when the combo chart includes bars."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"Whether numeric values are shown as percentages or as plain numbers."}},"description":"Default data label settings for the combo chart. Series-specific settings may override these."},"gap":{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The spacing between bars (gap width) within each category group."},"betweenSets":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The size preset for the gap between groups of bars. Requires clustered bar sets, from a color by category or color by scale, or multiple bar series with clustered stacking. Defaults to `auto`."}},"description":"The gap width between sets of bars on bar series. Requires a categorical x-axis."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"seriesDataLabel":{"type":"object","properties":{"area":{"type":"object","properties":{"clearance":{"oneOf":[{"type":"string","enum":["separated"]},{"type":"string","enum":["default"]}],"description":"Spacing between data labels and neighboring marks when labels could overlap lines or areas. Either `separated` to offset labels clear of the mark, or `default`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["endpoints"]},{"type":"string","enum":["most-recent"]},{"type":"string","enum":["all-points"]}],"description":"Which values and labels to show on each area series data label."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"showStroke":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["on"]},{"type":"string","enum":["off"]}],"description":"The stroke (outline) around data labels."}}},"bar":{"type":"object","properties":{"anchor":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["end"]},{"type":"string","enum":["middle"]},{"type":"string","enum":["outside-end"]},{"type":"string","enum":["start"]}],"description":"Position of the data label relative to its mark."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["all"]}],"description":"Which values and labels to show on each bar segment label."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"orient":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"Text direction for data labels."},"precision":{"type":"number","description":"The number of decimal places when labels include percentages."},"showStroke":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["on"]},{"type":"string","enum":["off"]}],"description":"The stroke (outline) around data labels."},"totals":{"type":"object","properties":{"display":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"fontSize":{"type":"number","description":"The font size for total labels, in pixels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["all"]}],"description":"Which aggregate total labels appear on the bars. Defaults to `auto`."},"orient":{"oneOf":[{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"The text direction for total labels."}},"description":"The aggregate total label options for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"Whether numeric values are shown as percentages or as plain numbers."}}},"line":{"type":"object","properties":{"clearance":{"oneOf":[{"type":"string","enum":["separated"]},{"type":"string","enum":["default"]}],"description":"Spacing between data labels and neighboring marks when labels could overlap lines or areas. Either `separated` to offset labels clear of the mark, or `default`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["endpoints"]},{"type":"string","enum":["most-recent"]},{"type":"string","enum":["all-points"]}],"description":"Which values and labels to show on each line series label."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"showStroke":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["on"]},{"type":"string","enum":["off"]}],"description":"The stroke (outline) around data labels."}}},"scatter":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"precision":{"type":"number","description":"The number of decimal places when labels use percent format."},"showStroke":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["on"]},{"type":"string","enum":["off"]}],"description":"The stroke (outline) around data labels."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"Whether numeric values are shown as percentages or as plain numbers."}}}},"description":"The per-series data label settings, overriding `dataLabel` for that series. Set any of `bar`, `line`, `area`, or `scatter`."},"pointStyle":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."},{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The minimum point size applied when a size field is set."}]}},"description":"The default point shape and size for scatter series."},"seriesPointStyle":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The Y-axis column for this scatter series. Sigma aggregates values associated with the same X-axis category."}}},{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."},{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The minimum point size applied when a size field is set."}]}}}]},"description":"The point style overrides for a series in a combo chart with the `scatter` type. Each entry lists only fields that differ from `pointStyle`."},"backgroundImage":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the background image. Supports `{{dynamic-text}}` formula references."}},"description":"The chart background image. The URL supports dynamic `{{formula}}` text."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"lineAreaStyle":{"type":"object","properties":{"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the area line is shown. Defaults to `shown` for layered area charts and `hidden` otherwise."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"Line stroke and area outline visibility."},"points":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether points are shown. Defaults to `shown`. `shape` and `size` cannot be set when `hidden`."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}},"description":"The points on the series. Configure shape, size, and visibility."}},"description":"Default interpolation, stroke, points, and null handling for line and area series. Requires at least one line or area series on the chart."},"seriesLineAreaStyle":{"type":"array","items":{"type":"object","required":["columnId","style"],"properties":{"columnId":{"type":"string","description":"Y-axis column id for a combo line or area layer."},"style":{"type":"object","properties":{"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the area line is shown. Defaults to `shown` for layered area charts and `hidden` otherwise."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"Line stroke and area outline visibility."},"points":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether points are shown. Defaults to `shown`. `shape` and `size` cannot be set when `hidden`."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}},"description":"The points on the series. Configure shape, size, and visibility."}},"description":"Line/area style override for this series (only fields that differ from `lineAreaStyle`)."}}},"description":"Line and area style overrides for combo charts, specified by the column identifier of each line or area series on the y-axis."},"refMarks":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","axis","value"],"properties":{"type":{"type":"string","enum":["line"],"description":"A reference line marking a single value on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The position of the reference line on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference line, including style, width, and color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]},{"allOf":[{"type":"object","required":["type","axis","value","endValue"],"properties":{"type":{"type":"string","enum":["band"],"description":"A reference band marking a range between two values on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The start position of the reference band on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."},"endValue":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"Band end position (constant, column aggregation, or formula)."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether a line outlining the reference band is shown. Set to `shown` to display it."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference band line, including style, width, and color."},"fill":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The fill color of the reference band. A hex code, `rgb()` value, or theme reference."}},"description":"The band fill color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]}]},"description":"Reference lines and bands on the chart."},"trellis":{"type":"object","properties":{"columnsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis columns. At most one entry."},"column":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis column."},"row":{"type":"object","properties":{"border":{"type":"string","enum":["hidden"],"description":"Whether a border is shown between trellis panels. Set to `hidden` to hide it."},"labels":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The label color, as a hex code or theme reference."}}}],"description":"The trellis labels. Set to `hidden` to hide them, or provide styling overrides."},"title":{"oneOf":[{"type":"string","enum":["hidden"],"description":"Hide this guide component."},{"type":"object","properties":{"text":{"type":"string","description":"The text of the trellis title."},"fontSize":{"type":"number","description":"The font size, in pixels."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The title color, as a hex code or theme reference."}}}],"description":"The trellis title. Set to `hidden` to hide it, or provide text and styling overrides."}},"description":"The format for the trellis row."},"rowsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed at this position."}}},{"type":"object","properties":{"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"],"description":"Set to `column` to sort trellis panels by another column, named in `columnId`."},"columnId":{"type":"string","description":"The identifier of the column to sort by."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation when sorting by another column."}}}]},{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["row-count"],"description":"Set to `row-count` to sort trellis panels by the number of rows."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"type":{"type":"string","enum":["values"],"description":"Set to `values` to sort by this column's own values. This is the default when `type` is omitted."}}}]}],"description":"The sort direction and type (`values`, `column`, or `row-count`)."}}}]},"description":"The identifier of the column that defines trellis rows. At most one entry."},"series":{"oneOf":[{"type":"string","enum":["row"]},{"type":"string","enum":["column"]}],"description":"Display each series in its own chart, arranged as a row or column of panels. Cannot be specified if `rowsBy` or `columnsBy` is specified. Not supported for every chart kind."},"share":{"type":"object","properties":{"color-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one color legend across the grid or each panel gets its own. Defaults to `shared`."},"size-legends":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Size legend display options for the trellis."},"x-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one category-axis scale or each scales to its own data. Defaults to `shared`. This is the category axis even when chart orientation renders it vertically."},"y-axis":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share one series-axis (value) scale or each scales to its own data. Defaults to `shared`. This is the series axis even when chart orientation renders it horizontally."},"y-axis-2":{"oneOf":[{"type":"string","enum":["shared"]},{"type":"string","enum":["separate"]}],"description":"Whether trellis panels share the secondary series-axis scale. Defaults to `shared`. Combo charts with a second value axis only."}},"description":"The scales and legends shared across trellis panels."},"tileSize":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["compact"]}],"description":"The size of charts in a trellis grid. Defaults to `auto` for category trellis, `compact` for trellis by series."}},"description":"Trellis configuration for the chart."},"trendlines":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","model"],"properties":{"columnId":{"type":"string","description":"The Y-axis column to fit the trend line to."},"model":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["quadratic"]},{"type":"string","enum":["polynomial"]},{"type":"string","enum":["exponential"]},{"type":"string","enum":["logarithmic"]},{"type":"string","enum":["power"]}],"description":"Regression model for the trend line."}}},{"type":"object","properties":{"degree":{"type":"number","description":"The polynomial order of the regression fit, from 3 to 7. Defaults to `3`. Only applies when `model` is `polynomial`."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The line style, width, and color for the trend line."},"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"value":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"The regression fit value (R²) drawn on the chart. Set `visibility` to `shown`, or omit the block to hide it."},"equation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"Regression equation. Omit the block to hide the equation."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"The position of the label and computed-value annotation for the trend line."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The label and value display options for the trend line."}}}]},"description":"The regression trend lines for the chart. Each trend line applies to a column plotted on the Y-axis."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Combo Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","yAxis"],"properties":{"id":{"type":"string","description":"The identifier of the waterfall chart."},"kind":{"type":"string","enum":["waterfall-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the waterfall chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the waterfall chart."},"yAxis":{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"oneOf":[{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."},{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."}}},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["bar"]},{"type":"string","enum":["line"]},{"type":"string","enum":["area"]},{"type":"string","enum":["scatter"]}],"description":"The chart shape for this series. Defaults to `bar`."}}}]}]},"description":"The column IDs for the Y-axis series. Lists every series on the chart, including those assigned to the secondary axis by `yAxis2`."}}},{"type":"object","properties":{"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The Y-axis formatting, including title, labels, marks, and scale."}}}],"description":"The columns used for the Y-axis."}}},{"type":"object","properties":{"xAxis":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for the X-axis."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."},"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The X-axis formatting, including title, labels, marks, and scale."}}}],"description":"The column used for the X-axis."},"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the chart."},"grouping":{"oneOf":[{"type":"string","enum":["stacked"]},{"type":"string","enum":["clustered"]}],"description":"The series grouping. Either `stacked` (default) or `clustered` (no stacking)."},"splitBy":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The column that splits the waterfall into multiple data series, plotted as cumulative segments."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"conditionalFormats":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","formula"],"properties":{"condition":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula for a conditional formatting rule. Can reference any column in the element. Must return a boolean."}}}]}]},{"type":"object","properties":{"style":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The cell background color, as a hex code."}}}}}]},"description":"Single-color conditional formatting rules applied to chart marks. Order matters; only the first matching rule applies."},"waterfallColors":{"type":"object","properties":{"decrease":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color for decreasing waterfall bars."},"increase":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color for increasing waterfall bars. Decreasing bars and totals use separate colors."},"total":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Color for subtotal and end total bars."}},"description":"The colors for increase, decrease, and total bars."},"waterfallShape":{"type":"object","properties":{"calculation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["difference"]}],"description":"How bar values combine. Defaults to `sum`."},"connectorLine":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether connector lines between bars are shown."},"connectorLineColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The connector line color."},"endTotal":{"type":"object","properties":{"label":{"type":"string","description":"The label text."},"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Set to `hidden` to hide the label. Omit to show."}},"description":"End total bar label options."},"subtotal":{"type":"object","properties":{"label":{"type":"string","description":"The label text."},"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Set to `hidden` to hide the label. Omit to show."}},"description":"Subtotal bar label options."}},"description":"The waterfall chart display options for connector lines, end value, and subtotals."},"startPoint":{"type":"object","properties":{"label":{"type":"string","description":"The start bar label text."},"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["first-value"]}}},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Constant numeric start value for the waterfall chart. Null clears the value."}}}]},{"type":"object","required":["columnId","func","type"],"properties":{"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation for a column-based start value."},"type":{"type":"string","enum":["column"]}}}],"description":"How the start value is computed."},"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Set to `hidden` to hide the start bar. Omit to show."}},"description":"The starting bar value and label. When a start bar is shown, the label defaults to `Start`."},"dataLabel":{"type":"object","properties":{"anchor":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["end"]},{"type":"string","enum":["middle"]},{"type":"string","enum":["outside-end"]},{"type":"string","enum":["start"]}],"description":"Position of the data label relative to its mark."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["min-max"]},{"type":"string","enum":["all"]}],"description":"Which values and labels to show on each bar segment label."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"precision":{"type":"number","description":"The number of decimal places when labels include percentages."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"Whether numeric values are shown as percentages or as plain numbers."}},"description":"Data label typography, placement, and display options."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"backgroundImage":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the background image. Supports `{{dynamic-text}}` formula references."}},"description":"The chart background image. The URL supports dynamic `{{formula}}` text."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"refMarks":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","axis","value"],"properties":{"type":{"type":"string","enum":["line"],"description":"A reference line marking a single value on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The position of the reference line on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference line, including style, width, and color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]},{"allOf":[{"type":"object","required":["type","axis","value","endValue"],"properties":{"type":{"type":"string","enum":["band"],"description":"A reference band marking a range between two values on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The start position of the reference band on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."},"endValue":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"Band end position (constant, column aggregation, or formula)."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether a line outlining the reference band is shown. Set to `shown` to display it."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference band line, including style, width, and color."},"fill":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The fill color of the reference band. A hex code, `rgb()` value, or theme reference."}},"description":"The band fill color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]}]},"description":"Reference lines and bands on the chart."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Waterfall Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","stages","value"],"properties":{"id":{"type":"string","description":"The identifier of the sankey chart."},"kind":{"type":"string","enum":["sankey-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the sankey chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the sankey chart."},"stages":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."}}}]},"description":"Ordered stage dimension columns. Empty when no stages are bound yet."},"value":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The column whose values define flow magnitude."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"color":{"type":"object","required":["by","scheme"],"properties":{"by":{"type":"string","enum":["palette"]},"scheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"Named categorical palette or custom hex list applied to flow colors."}},"description":"Flow color palette override (`by: palette`). Omitted when the theme default applies."},"dataLabel":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["value"]},{"type":"string","enum":["percent"]},{"type":"string","enum":["stage-value"]},{"type":"string","enum":["stage-percent"]},{"type":"string","enum":["value-percent"]},{"type":"string","enum":["all"]}],"description":"Which stage names, values, and percentages to show on flow labels."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"precision":{"type":"number","description":"The number of decimal places when labels include percentages."}},"description":"Data label typography and sankey-specific label display options."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Hover tooltip: `columns` adds fields to the tooltip; `format.columnNames` toggles column-name display."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Sankey Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns"],"properties":{"id":{"type":"string","description":"The identifier of the treemap chart."},"kind":{"type":"string","enum":["treemap-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the treemap chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the treemap chart."}}},{"type":"object","properties":{"category":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"Optional column whose values define treemap tile categories."},"splitBy":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"Optional column that splits categories into nested groups."},"value":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},"description":"Optional measure columns that define tile size."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"Color configuration: single hex or continuous gradient (`by: 'scale'`). Categorical `by: 'category'` is not supported."},"label":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},"description":"Optional columns rendered as text labels on tiles."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Hover tooltip: `columns` adds fields to the tooltip; `format.columnNames` toggles column-name display."},"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"mark":{"oneOf":[{"type":"object","properties":{"method":{"oneOf":[{"type":"string","enum":["squarify"]},{"type":"string","enum":["binary"]},{"type":"string","enum":["slicedice"]}],"description":"Layout algorithm. Defaults to squarify."},"nodeSpacing":{"oneOf":[{"type":"number","enum":[0]},{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]},{"type":"number","enum":[6]},{"type":"number","enum":[7]},{"type":"number","enum":[8]}],"description":"Gap between tiles within a group (format panel: Node spacing)."},"groupSpacing":{"oneOf":[{"type":"number","enum":[0]},{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]},{"type":"number","enum":[6]},{"type":"number","enum":[7]},{"type":"number","enum":[8]}],"description":"Gap between split-by groups (format panel: Group spacing). Only applies when both category and splitBy channels are set."}}},{"type":"null"}],"description":"Treemap layout (format panel: Layout): method, node spacing, and group spacing."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."}}}],"description":"","title":"Treemap Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","stage","series"],"properties":{"id":{"type":"string","description":"The identifier of the funnel chart."},"kind":{"type":"string","enum":["funnel-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the funnel chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the funnel chart."},"stage":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."}}}],"description":"The column defining funnel stages."},"series":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The aggregated value column for funnel segment size."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Hover tooltip: `columns` adds fields to the tooltip; `format` sets column-name display options."},"labels":{"type":"object","properties":{"stage":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether this funnel label is visible."},"anchor":{"oneOf":[{"type":"string","enum":["start"]},{"type":"string","enum":["middle"]},{"type":"string","enum":["end"]}],"description":"Label position along the funnel segment: 'start', 'middle', or 'end'."},"fontSize":{"type":"number","description":"Label font size in pixels."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"value":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether this funnel label is visible."},"anchor":{"oneOf":[{"type":"string","enum":["start"]},{"type":"string","enum":["middle"]},{"type":"string","enum":["end"]}],"description":"Label position along the funnel segment: 'start', 'middle', or 'end'."},"fontSize":{"type":"number","description":"Label font size in pixels."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"percent":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether this funnel label is visible."},"anchor":{"oneOf":[{"type":"string","enum":["start"]},{"type":"string","enum":["middle"]},{"type":"string","enum":["end"]}],"description":"Label position along the funnel segment: 'start', 'middle', or 'end'."},"fontSize":{"type":"number","description":"Label font size in pixels."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"percentType":{"oneOf":[{"type":"string","enum":["total"]},{"type":"string","enum":["prev"]}],"description":"Conversion-rate denominator: 'total' (% of total) or 'prev' (% of prior stage)."}},"description":"Stage, value, and conversion-rate label visibility, placement, and typography."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Funnel Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","value"],"properties":{"id":{"type":"string","description":"The identifier of the gauge chart."},"kind":{"type":"string","enum":["gauge-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the gauge chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the gauge chart."},"value":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"Column bound to the gauge value shelf."}}},{"type":"object","properties":{"colorScale":{"type":"object","properties":{"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}},"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."}},"description":"Continuous color scale for the value arc when gaugeMarks.colorMode is 'by-scale'."},"conditionalFormats":{"type":"array","items":{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["gauge"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","formula"],"properties":{"condition":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula for a conditional formatting rule. Can reference any column in the element. Must return a boolean."}}}]},{"type":"object","properties":{"compareTo":{"oneOf":[{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"When set, the rule threshold is a percentage of the gauge's maximum or target."},"style":{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Gauge arc background color when the rule matches."}}}}}]},"description":"Conditional formatting rules applied to the gauge value arc."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"dataLabel":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."}},"description":"Data label visibility and typography for the gauge value."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"gaugeMarks":{"type":"object","properties":{"colorMode":{"oneOf":[{"type":"string","enum":["single-color"]},{"type":"string","enum":["by-scale"]}],"description":"Color shelf mode: 'single-color' (default) or 'by-scale'. Omit when single-color."},"fillColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Gauge mark color (hex, rgb(), or theme reference)."},"gaugeColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Gauge track color (Format panel: Gauge color)."},"needleColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Needle color when showNeedle is shown."},"showColorOnGauge":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Apply conditional-format fill color to the gauge arc. Omit when hidden (default)."},"showFill":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Value arc fill visibility (Format panel: Show gauge fill). Omit when shown (default)."},"showNeedle":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Gauge needle visibility. Omit when shown (default)."},"targetColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Target mark color when a target channel is bound."}},"description":"Gauge track, needle, fill, and color-mode mark configuration."},"maximum":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"Column bound to the maximum shelf."},"minimum":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"Column bound to the minimum shelf."},"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"target":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"Column bound to the target shelf."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Gauge Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","yAxis"],"properties":{"id":{"type":"string","description":"The identifier of the box chart."},"kind":{"type":"string","enum":["box-chart"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the box chart."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the box chart."},"yAxis":{"allOf":[{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"oneOf":[{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."},{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for a Y-axis series. Identifies which column provides the data values for this series."}}},{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["bar"]},{"type":"string","enum":["line"]},{"type":"string","enum":["area"]},{"type":"string","enum":["scatter"]}],"description":"The chart shape for this series. Defaults to `bar`."}}}]}]},"description":"The column IDs for the Y-axis series. Lists every series on the chart, including those assigned to the secondary axis by `yAxis2`."}}},{"type":"object","properties":{"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The Y-axis formatting, including title, labels, marks, and scale."}}}],"description":"The columns used for the Y-axis."}}},{"type":"object","properties":{"xAxis":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID for the X-axis."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order."},"format":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the axis is shown. Set to `hidden` to hide it."}}},{"type":"object","properties":{"title":{"type":"object","properties":{"text":{"type":"string","description":"The axis title text."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}}},"labels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","properties":{"labelAngle":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The label angle in degrees, or `auto` to set the angle automatically."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size automatically."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"allowLongerLabels":{"type":"boolean","description":"Whether to allow longer axis labels without truncation."}}}]},"marks":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The axis mark display. One of `none`, `tick` (marks along axis), `grid` (background lines), or `both`."},"scale":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."}}},"zero":{"type":"boolean","description":"Whether to always include zero in the axis domain."},"reverse":{"type":"boolean","description":"Whether to reverse the axis direction."},"hideZeroLine":{"type":"boolean","description":"Whether to hide the zero guideline on the axis."}}},"tickSpacing":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["auto"],"description":"Set axis mark spacing automatically."}}},{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","enum":["count"],"description":"Set the axis mark count spacing based on an approximate number of axis marks set in `count`."},"count":{"type":"number","description":"The approximate number of axis marks, from 1 to 30. Defaults to `5`. The exact count may vary to produce regularly spaced values."}}},{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"type":"string","enum":["auto"],"description":"The time interval unit, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","unit"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["time"],"description":"The axis mark spacing for a time-scale axis."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time interval unit."}}},{"type":"object","properties":{"step":{"type":"number","description":"Number of units between each axis mark."},"anchor":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Epoch milliseconds for the first axis mark, or null to start at the next whole unit."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["unit","step","mark"],"properties":{"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time unit for minor axis marks."},"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]},{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"string","enum":["auto"],"description":"The numeric step between axis marks, chosen automatically."}}},{"allOf":[{"type":"object","required":["type","scale","step"],"properties":{"type":{"type":"string","enum":["interval"],"description":"Set axis marks based on a set interval on a time or linear scale."},"scale":{"type":"string","enum":["linear"],"description":"The tick spacing for a linear-scale axis."},"step":{"type":"number","description":"The distance between axis marks in the data units of the axis. Requires `scale: 'linear'`."}}},{"type":"object","properties":{"anchor":{"type":"number","description":"Numeric anchor for tick alignment."},"minor":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the minor axis marks are shown. Set to `hidden` to hide them."}}},{"type":"object","required":["step","mark"],"properties":{"step":{"type":"number","description":"The minor axis mark step size."},"mark":{"oneOf":[{"type":"string","enum":["tick"]},{"type":"string","enum":["grid"]},{"type":"string","enum":["both"]}],"description":"The style of the minor axis marks drawn between the main axis marks."}}}]}}}]}]}}}],"description":"The X-axis formatting, including title, labels, marks, and scale."}}}],"description":"The column used for the X-axis."},"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The chart description, displayed as a subtitle or tooltip text."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["top"]},{"type":"string","enum":["right"]},{"type":"string","enum":["bottom"]},{"type":"string","enum":["left"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position. Defaults to `auto`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"colorLegend":{"type":"string","enum":["hidden"],"description":"Whether the color legend is shown when both a color and a size legend would show. Only applies on a scatter chart."},"sizeLegend":{"type":"string","enum":["hidden"],"description":"Set to `hidden` to hide the size legend when a size channel is present. Only applies on a scatter chart."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"Legend visibility, position, and label styling."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Hover tooltip: `columns` adds fields to the tooltip; `format` sets column-name display options."},"orientation":{"type":"string","enum":["horizontal"],"description":"Box orientation. Omit (the default) for vertical boxes; set to 'horizontal' for horizontal boxes."},"splitBy":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"Optional column that splits the box plot into series."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"boxShape":{"type":"object","properties":{"points":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"string","enum":["outliers-only"]},{"type":"string","enum":["all-points"]}],"description":"Point display: 'hidden' (show points off), 'outliers-only' (default), or 'all-points'."}},"description":"Box plot point display (none, outliers, or all points)."},"dataLabel":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the data label text. A hex code, `rgb()` value, or theme reference."},"fontSize":{"type":"number","description":"The font size for data labels, in pixels."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight for data labels."},"labelDisplay":{"type":"array","items":{"oneOf":[{"type":"string","enum":["quartiles"]},{"type":"string","enum":["median"]},{"type":"string","enum":["min-max"]}]},"description":"Box plot statistics to show on data labels: quartiles (Q1/Q3), median, and/or min-max."},"labels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether values appear on chart marks."},"orient":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"Text direction for data labels."},"precision":{"type":"number","description":"The number of decimal places when labels include percentages."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"Whether numeric values are shown as percentages or as plain numbers."}},"description":"Data label typography, orientation, and box statistic display options."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"backgroundImage":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the background image. Supports `{{dynamic-text}}` formula references."}},"description":"The chart background image. The URL supports dynamic `{{formula}}` text."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"refMarks":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","axis","value"],"properties":{"type":{"type":"string","enum":["line"],"description":"A reference line marking a single value on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The position of the reference line on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference line, including style, width, and color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]},{"allOf":[{"type":"object","required":["type","axis","value","endValue"],"properties":{"type":{"type":"string","enum":["band"],"description":"A reference band marking a range between two values on the chart."},"axis":{"oneOf":[{"type":"string","enum":["axis"]},{"type":"string","enum":["series"]},{"type":"string","enum":["series2"]}],"description":"The axis the reference mark applies to. One of primary (`axis`), primary series (`series`), or secondary series (`series2`)."},"value":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"The start position of the reference band on the axis, as one of three shapes. Use `{ type: 'constant', value }` for a fixed number, `{ type: 'column', columnId, func }` for a column aggregation, or `{ type: 'formula', formula }` for a formula."},"endValue":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["constant"]}}},{"type":"object","properties":{"value":{"type":"number","description":"The constant position of the reference line on the axis."}}}]},{"type":"object","required":["type","columnId","func"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The column to aggregate."},"func":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["median"]}],"description":"Aggregation for a column-based mark value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that defines the mark position. Must return a number or datetime."}}}],"description":"Band end position (constant, column aggregation, or formula)."}}},{"type":"object","properties":{"line":{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether a line outlining the reference band is shown. Set to `shown` to display it."},"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The color of the reference line. A hex code, `rgb()` value, or theme reference."}},"description":"The stroke styling of the reference band line, including style, width, and color."},"fill":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The fill color of the reference band. A hex code, `rgb()` value, or theme reference."}},"description":"The band fill color."}}},{"type":"object","properties":{"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"annotation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Annotation is shown. Omit the `label` or `annotation` block entirely to hide it."}},"description":"Whether to display the reference mark value. Set to `{ visibility: 'shown' }` to show, or omit the block to hide."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"Label and computed-value annotation position."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"Shared placement and typography for label and annotation."},"scope":{"oneOf":[{"type":"string","enum":["chart"]},{"type":"string","enum":["cell"]}],"description":"The scope for reference mark calculations in a trellised chart. One of `chart` (default, calculated once and shared) or `cell` (calculated per panel)."}}}]}]},"description":"Reference lines and bands on the chart."},"trendlines":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","model"],"properties":{"columnId":{"type":"string","description":"The Y-axis column to fit the trend line to."},"model":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["quadratic"]},{"type":"string","enum":["polynomial"]},{"type":"string","enum":["exponential"]},{"type":"string","enum":["logarithmic"]},{"type":"string","enum":["power"]}],"description":"Regression model for the trend line."}}},{"type":"object","properties":{"degree":{"type":"number","description":"The polynomial order of the regression fit, from 3 to 7. Defaults to `3`. Only applies when `model` is `polynomial`."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The line style."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Line width in pixels (1–5)."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The line style, width, and color for the trend line."},"label":{"allOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}}},{"type":"object","properties":{"text":{"type":"string","description":"The label text."}}}],"description":"The custom label. Omit to hide the label."},"value":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"The regression fit value (R²) drawn on the chart. Set `visibility` to `shown`, or omit the block to hide it."},"equation":{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether the label is shown. Set to `shown` to display it. Omit the `label` or `value` block to hide it."}},"description":"Regression equation. Omit the block to hide the equation."},"caption":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-right"]},{"type":"string","enum":["top-center"]},{"type":"string","enum":["top-left"]},{"type":"string","enum":["bottom-right"]},{"type":"string","enum":["bottom-center"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["middle-right"]},{"type":"string","enum":["middle-left"]}],"description":"The position of the label and computed-value annotation for the trend line."},"fontSize":{"type":"number","description":"The font size for the label and annotation text, in pixels. Defaults to `12`."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}},"description":"The label and value display options for the trend line."}}}]},"description":"The regression trend lines for the chart. Each trend line applies to a column plotted on the Y-axis."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Box Chart"},{"allOf":[{"type":"object","required":["id","kind","source","columns","latitude","longitude"],"properties":{"id":{"type":"string","description":"The identifier of the point map."},"kind":{"type":"string","enum":["point-map"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the point map."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the point map."},"latitude":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The column whose values are point latitudes (degrees, WGS84)."},"longitude":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The column whose values are point longitudes (degrees, WGS84)."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."}}}],"title":"Shown title"}],"description":"Display name for the map. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The map description text and styling. Requires a non-empty `text` unless `visibility` is `hidden`."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position on the map."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"The legend display options, including visibility, position, and label styling."},"mapStyle":{"oneOf":[{"oneOf":[{"type":"object"},{"allOf":[{"type":"object","properties":{"accessToken":{"type":"string","description":"Mapbox access token. Write-only: never returned on read."},"allowZoom":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether pan and zoom are enabled on the map. Defaults to `shown`."}}},{"type":"object","required":["baseStyle","styleUrl"],"properties":{"baseStyle":{"type":"string","enum":["custom"],"description":"Custom Mapbox style. Requires `styleUrl`."},"styleUrl":{"type":"string","description":"The Mapbox style URL. Required when `baseStyle` is `custom`."}}}]},{"type":"object"},{"oneOf":[{"type":"object"},{"type":"object"},{"type":"object"}]}]},{"type":"null"}],"description":"The display settings for the map, including base style, custom URL, pan and zoom, and a write-only Mapbox access token."},"pointStyle":{"oneOf":[{"type":"object","properties":{"opacity":{"type":"number","description":"Mark opacity from 0 to 1. Omit when fully opaque (1)."},"pointSize":{"oneOf":[{"type":"number","description":"Point diameter in pixels (1–40). Omit when default (5)."},{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"},"description":"Minimum and maximum point diameters when a size field is set, in pixels. Each must be an integer from 1 to 40. Defaults to [3, 15]."}]}}},{"type":"null"}],"description":"The point mark opacity and size. Set to `null` to remove point styling."},"size":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The column whose values determine point size. Each point is sized relative to others in the chart."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"label":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},"description":"Optional columns rendered as text labels next to each point."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the map. Specify fields with the `columns` property."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Point Map"},{"allOf":[{"type":"object","required":["id","kind","source","columns","region"],"properties":{"id":{"type":"string","description":"The identifier of the region map."},"kind":{"type":"string","enum":["region-map"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the region map."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the region map."},"region":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},{"type":"object","required":["regionType"],"properties":{"regionType":{"oneOf":[{"type":"string","enum":["country"]},{"type":"string","enum":["us-state"]},{"type":"string","enum":["us-county"]},{"type":"string","enum":["us-zipcode"]},{"type":"string","enum":["us-cbsa"]},{"type":"string","enum":["us-postal-place"]},{"type":"string","enum":["ca-province"]}],"description":"The geographic region type the column represents (country, us-state, etc.)."}}}],"description":"The region column and the kind of region it contains."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."}}}],"title":"Shown title"}],"description":"Display name for the map. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The map description text and styling. Requires a non-empty `text` unless `visibility` is `hidden`."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position on the map."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"The legend display options, including visibility, position, and label styling."},"mapStyle":{"oneOf":[{"oneOf":[{"type":"object"},{"allOf":[{"type":"object","properties":{"accessToken":{"type":"string","description":"Mapbox access token. Write-only: never returned on read."},"allowZoom":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether pan and zoom are enabled on the map. Defaults to `shown`."}}},{"type":"object","required":["baseStyle","styleUrl"],"properties":{"baseStyle":{"type":"string","enum":["custom"],"description":"Custom Mapbox style. Requires `styleUrl`."},"styleUrl":{"type":"string","description":"The Mapbox style URL. Required when `baseStyle` is `custom`."}}}]},{"type":"object"},{"oneOf":[{"type":"object"},{"type":"object"},{"type":"object"}]}]},{"type":"null"}],"description":"The display settings for the map, including base style, custom URL, pan and zoom, and a write-only Mapbox access token."},"regionStyle":{"oneOf":[{"type":"object","properties":{"opacity":{"type":"number","description":"Mark opacity from 0 to 1. Omit when fully opaque (1)."}}},{"type":"null"}],"description":"The region fill styling, as an object with an `opacity` from 0 to 1. Set to `null` to clear it."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"label":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}}},"description":"The columns rendered as text labels on each region."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the map. Specify fields with the `columns` property."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Region Map"},{"allOf":[{"type":"object","required":["id","kind","source","columns","geography"],"properties":{"id":{"type":"string","description":"The identifier of the geography map element."},"kind":{"type":"string","enum":["geography-map"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the geography map."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},"description":"The columns used by the geography map."},"geography":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID."}},"description":"The identifier of a Geography column or column of GeoJSON geometries."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."}}}],"title":"Shown title"}],"description":"Display name for the map. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The map description text and styling. Requires a non-empty `text` unless `visibility` is `hidden`."},"legend":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the legend is shown. Set to `hidden` to hide the whole legend. No other legend field can be set alongside it. Omit `visibility` to configure `position`, `color`, `fontSize`, or the legend components instead."}}},{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["top-left"]},{"type":"string","enum":["top-right"]},{"type":"string","enum":["bottom-left"]},{"type":"string","enum":["bottom-right"]}],"description":"The legend position on the map."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Legend label font size in pixels."},"header":{"type":"string","enum":["hidden"],"description":"Whether the legend header is shown. Set to `hidden` to hide it."}}}],"description":"The legend display options, including visibility, position, and label styling."},"mapStyle":{"oneOf":[{"oneOf":[{"type":"object"},{"allOf":[{"type":"object","properties":{"accessToken":{"type":"string","description":"Mapbox access token. Write-only: never returned on read."},"allowZoom":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether pan and zoom are enabled on the map. Defaults to `shown`."}}},{"type":"object","required":["baseStyle","styleUrl"],"properties":{"baseStyle":{"type":"string","enum":["custom"],"description":"Custom Mapbox style. Requires `styleUrl`."},"styleUrl":{"type":"string","description":"The Mapbox style URL. Required when `baseStyle` is `custom`."}}}]},{"type":"object"},{"oneOf":[{"type":"object"},{"type":"object"},{"type":"object"}]}]},{"type":"null"}],"description":"The display settings for the map, including base style, custom URL, pan and zoom, and a write-only Mapbox access token."},"featureStyle":{"oneOf":[{"type":"object","properties":{"opacity":{"type":"number","description":"Mark opacity from 0 to 1. Omit when fully opaque (1)."},"pointSize":{"type":"number","description":"Point diameter in pixels (1–40). Omit when default (5)."}}},{"type":"null"}],"description":"The opacity and point size of features."},"color":{"oneOf":[{"type":"object","required":["by","value"],"properties":{"by":{"type":"string","enum":["single"]},"value":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["category"]},"column":{"type":"string","description":"The identifier of the column whose values determine categorical color assignment. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"customColors":{"type":"array","items":{"type":"object","required":["value","color"],"properties":{"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"Column value the color applies to; null pins the color to blank/missing values."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"description":"Per-value color overrides: pins specific column values to specific colors, independent of the categorical scheme."}}}]},{"allOf":[{"type":"object","required":["by","column"],"properties":{"by":{"type":"string","enum":["scale"]},"column":{"type":"string","description":"The identifier of the numeric column whose values drive the continuous color gradient. Must be a column in the chart."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The array of colors defining the palette or gradient, as hex codes (`#rgb` or `#rrggbb`). A continuous gradient needs at least two entries."},"domain":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the continuous color scale. Defaults to the data's minimum value."},"max":{"type":"number","description":"The upper bound of the continuous color scale. Defaults to the data's maximum value."},"mid":{"type":"number","description":"The midpoint of the continuous color scale. Specify to make the gradient diverging. Omit for a sequential gradient."}}}}}]}],"description":"The color configuration for chart marks. One of single hex, categorical column, or continuous gradient."},"tooltip":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The column ID shown in the hover tooltip."}}},"description":"Columns shown in the hover tooltip, in addition to the chart's own columns."},"format":{"type":"object","properties":{"columnNames":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether column names appear in the tooltip. Defaults to `true`."},"multiSeries":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Tooltip display mode for the chart. Defaults to multiple series for line and area charts, single series for bar charts."},"valueFormat":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["number"]}],"description":"The tooltip value format. Omit when the chart default applies."}},"description":"The tooltip display options for the chart."}},"description":"Tooltip display options for the map. Specify fields with the `columns` property."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this chart."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Geography Map"},{"allOf":[{"type":"object","required":["id","kind","source","columns","values"],"properties":{"id":{"type":"string","description":"The identifier of the pivot table."},"kind":{"type":"string","enum":["pivot-table"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source for the pivot table."},"columns":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},{"type":"object","properties":{"showOnTotals":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether pivot value column labels appear on total cells for this measure. Defaults to `shown`."}}}]},"description":"The columns used by the pivot table."},"values":{"type":"array","items":{"type":"string"},"description":"The column IDs used as value measures."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}},"description":"The pivot table description, shown as a subtitle or tooltip."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"rowsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed on this shelf position."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order for this column group."},"showValuesAggregatedAt":{"type":"string","enum":["every-parent-row"],"description":"Row subtotals aggregated at every parent row, on pivot row dimensions only. Omit for immediate parent row only."}}}]},"description":"Column IDs placed in the pivot rows."},"columnsBy":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column ID placed on this shelf position."}}},{"type":"object","properties":{"sort":{"allOf":[{"type":"object","required":["direction"],"properties":{"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"The aggregate function applied to the sort column. Only applies when `by` references a column, not `row-count`. The numeric-only aggregations `sum`, `avg`, `median`, `stddev`, and `variance` are rejected on a non-numeric column."}}}],"description":"The sort order for this column group."},"showValuesAggregatedAt":{"type":"string","enum":["every-parent-row"],"description":"Row subtotals aggregated at every parent row, on pivot row dimensions only. Omit for immediate parent row only."}}}]},"description":"The column IDs placed in the pivot columns. These columns define the pivot table's column headers and structure the data horizontally."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"conditionalFormats":{"type":"array","items":{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["single"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","formula"],"properties":{"condition":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula for a conditional formatting rule. Can reference any column in the element. Must return a boolean."}}}]},{"type":"object","properties":{"style":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The cell background color, as a hex code."},"color":{"type":"string","description":"The font color, as a hex code."},"bold":{"type":"boolean"},"italic":{"type":"boolean"},"underline":{"type":"boolean"},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"Number or datetime override, in d3 format, for the displayed value. E.g., `#,##0.00` for thousands separators and two decimals."}}}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["backgroundScale"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The hex colors that define the gradient, as an array of 2 or more colors."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."},"mid":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The midpoint value for a diverging color scale. Omit for a sequential scale."}}},"order":{"oneOf":[{"type":"string","enum":["descending"]},{"type":"string","enum":["ascending"]}]},"nullBehavior":{"oneOf":[{"type":"string","enum":["asZero"]},{"type":"string","enum":["asNull"]}]},"steps":{"type":"number","description":"Quantize the continuous gradient into N discrete buckets."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fontScale"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The hex colors that define the gradient, as an array of 2 or more colors."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."},"mid":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The midpoint value for a diverging color scale. Omit for a sequential scale."}}},"order":{"oneOf":[{"type":"string","enum":["descending"]},{"type":"string","enum":["ascending"]}]},"nullBehavior":{"oneOf":[{"type":"string","enum":["asZero"]},{"type":"string","enum":["asNull"]}]},"steps":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["dataBars"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The hex colors that define the gradient, as an array of 2 or more colors."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."},"mid":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The midpoint value for a diverging color scale. Omit for a sequential scale."}}},"order":{"oneOf":[{"type":"string","enum":["descending"]},{"type":"string","enum":["ascending"]}]},"valueLabels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"string","enum":["shown"]}]}}}]}]},{"type":"object","properties":{"includeValues":{"type":"boolean","description":"Whether to apply this formatting to data cells. Defaults to `true`."},"includeSubtotals":{"type":"boolean","description":"Whether to apply this formatting to subtotal rows. Defaults to `false`."},"includeGrandTotals":{"type":"boolean","description":"Whether to apply this formatting to grand total rows. Defaults to `false`."}}}]},"description":"Conditional formatting rules applied to value cells. Later rules take precedence over earlier ones."},"tableStyle":{"allOf":[{"$ref":"#/components/schemas/TableStyle"}],"description":"The style options for the pivot table."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The mark formatting applied to sparkline columns."},"tableComponents":{"type":"object","description":"Whether pivot table components are shown, such as column and row headers. Defaults to `shown`."},"axisTotals":{"type":"array","items":{"allOf":[{"type":"object","required":["axisId"],"properties":{"axisId":{"type":"string","description":"The identifier of the pivot row or column dimension, or `grand-row-total` / `grand-column-total` for a grand total."}}},{"type":"object","properties":{"calculations":{"type":"array","items":{"type":"object","required":["columnId","formula"],"properties":{"columnId":{"type":"string","description":"The identifier of the value column this entry applies to."},"formula":{"type":"string","description":"The custom aggregate formula for this value column in this total, for example `Sum([Sales Quantity])`."}}},"description":"Per-value custom aggregate formulas for this total."},"cellFormats":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The identifier of the value column this entry applies to."}}},{"type":"object","properties":{"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal text alignment."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}]},"textWrap":{"oneOf":[{"type":"string","enum":["wrap"]},{"type":"string","enum":["clip"]}],"description":"The text overflow behavior. Defaults to `clip`."}}}]},"description":"The cell formatting overrides for total cells in this pivot table."},"label":{"type":"string","description":"The text for the custom total label."},"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether this total is shown. Omit to use the Totals format-panel default."}}}]},"description":"The display options for pivot table totals and subtotals."},"totals":{"type":"object","properties":{"subTotalColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"subTotalBackgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"subTotalFontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"showSubtotals":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["when-collapsed"]}],"description":"Whether pivot subtotals are always shown or only while pivot rows are collapsed. Defaults to `always`."},"grandTotalColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"grandTotalBackgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"grandTotalFontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"showGrandTotals":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}]},"totalPosition":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]}],"description":"The total position. Defaults to `last`."}},"description":"The styling and default visibility for pivot table total rows and columns."},"display":{"type":"object","properties":{"emptyCellDisplay":{"type":"string","description":"Text shown in empty pivot value cells."},"measureShelfPosition":{"type":"number","description":"The position of the pivot values among row and column dimensions. Defaults to -1 (last)."},"repeatRowLabels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether row labels repeat on each row. Applies when multiple pivot rows display as separate columns."},"rowLayout":{"oneOf":[{"type":"string","enum":["single-column"]},{"type":"string","enum":["separate-columns"]}],"description":"The layout for row dimensions. One of `single-column` (default, stepped) or `separate-columns`."},"showLabels":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether measure labels appear in the pivot header area."},"stacked":{"oneOf":[{"type":"string","enum":["stacked"]},{"type":"string","enum":["side-by-side"]}],"description":"The placement of the values group when it holds multiple measures. `stacked` lists them as extra rows, `side-by-side` (default) lists them as extra columns."},"headerWidths":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["columnId","width"],"properties":{"columnId":{"type":"string","description":"The column to resize. Either a `rowsBy` field ID for headers, or the identifier of one pivot body data column (crossing a pivot column value with a measure) for body widths."},"width":{"type":"number","description":"Column width in pixels."}}},"description":"Per pivot row header widths."},"measureLabelWidth":{"type":"number","description":"Width in pixels of the values column, shown when a pivot has multiple values in stacked layout."},"uniformWidth":{"type":"number","description":"The uniform width for all pivot row header columns after bulk resize, in pixels. Must be a positive number. Cannot be specified if `columns` is specified."}},"description":"The width settings for row-header columns in the pivot table."},"bodyWidths":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","required":["columnId","width"],"properties":{"columnId":{"type":"string","description":"The column to resize. Either a `rowsBy` field ID for headers, or the identifier of one pivot body data column (crossing a pivot column value with a measure) for body widths."},"width":{"type":"number","description":"Column width in pixels."}}},"description":"Per pivot body leaf column widths."},"uniformWidth":{"type":"number","description":"The uniform width applied to all pivot body (value) columns, in pixels. Must be a positive number. Cannot be specified if `columns` is specified."}},"description":"The widths of the value columns. Either a single uniform width for all columns, or per-column widths set individually."}},"description":"Pivot table display options, including empty cell text, value stacking, measure labels, row layout, values position, repeat row labels, and column widths."},"frozenColumn":{"oneOf":[{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column to freeze. This column and any column visually to its left are frozen."}}},{"type":"object","properties":{"fieldValues":{"type":"array","items":{"type":"object","required":["fieldId","value"],"properties":{"fieldId":{"type":"string","description":"Pivot shelf field id for a dimension value at the freeze point."},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"description":"Dimension member value at the freeze point."}}},"description":"The pivot dimension values identifying which repeated column to freeze. Each value must match its column’s data type."}}}]},{"type":"null"}],"description":"The frozen column configuration. Freezes this column and all columns to its left, keeping them visible when scrolling right."},"adhocCalcs":{"type":"array","items":{"allOf":[{"type":"object","required":["id","inColumn","position"],"properties":{"id":{"type":"string","description":"Identifier for the ad hoc calculation row. Must be unique among ad hoc calculations and must not match a column ID on the pivot table."},"inColumn":{"type":"string","description":"The identifier of the row or column dimension for this calculation. Can also be set to `grand-row-total` or `grand-column-total`."},"position":{"type":"string","enum":["above","below"],"description":"The position of the row relative to the associated row."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the ad hoc calculation."},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"description":"Panel “Select value” for the inColumn row dimension."},"in":{"type":"array","items":{"type":"object","required":["columnId","value"],"properties":{"columnId":{"type":"string","description":"The identifier of the parent row or column dimension. Must share an axis with, and precede, `inColumn`."},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"description":"The dimension value at this parent level."}}},"description":"The dimension values of the parent row above the calculation."},"anchorRow":{"oneOf":[{"type":"string","enum":["subtotal"]},{"type":"string","enum":["data"]}],"description":"The row or column type. Specify `subtotal` for subtotal or grand-total rows and omit for data rows or columns."},"calculations":{"type":"array","items":{"type":"object","required":["columnId","formula"],"properties":{"columnId":{"type":"string","description":"The identifier of the value column this entry applies to."},"formula":{"type":"string","description":"Formula override for this value column in the ad hoc row."}}},"description":"The formula for each value column in this ad hoc row."}}}]},"description":"The ad hoc calculation rows or columns in the pivot table."},"folders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the folder."},"name":{"type":"string","description":"The name of the folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns and folders the folder contains."}}}]},"description":"The folders that organize pivot columns on the row, column, and value groups."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to the pivot table and their configurations."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Pivot Table"}],"description":"","title":"Data elements"},{"allOf":[{"type":"object","required":["id","kind","text"],"properties":{"id":{"type":"string","description":"The identifier of the button."},"kind":{"type":"string","enum":["button"]},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}}},{"type":"object","properties":{"appearance":{"oneOf":[{"type":"string","enum":["filled"]},{"type":"string","enum":["outline"]},{"type":"string","enum":["text"]}],"description":"The visual style of the button. Defaults to `filled`."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]},{"type":"string","enum":["stretch"]}],"description":"The horizontal alignment."},"size":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The size of the button."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape for the button. Omit to inherit from the workbook theme."},"fillColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The background fill color. A hex code, `rgb()` value, or theme reference."},"fontColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The label text color. A hex code, `rgb()` value, or theme reference."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The label font weight."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this button."},"popover":{"type":"object","properties":{"showFilterCount":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the trigger shows the number of modified controls: 'shown' or 'hidden'."}},"description":"Presentation settings for a popover triggered by this button."}}}],"description":"","title":"Button"},{"allOf":[{"$ref":"#/components/schemas/Control"}],"title":"Control"},{"allOf":[{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string","description":"The identifier of the divider."},"kind":{"type":"string","enum":["divider"]}}},{"type":"object","properties":{"direction":{"oneOf":[{"type":"string","enum":["horizontal"]},{"type":"string","enum":["vertical"]}],"description":"The orientation of the divider. Defaults to `horizontal`."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]},{"type":"string","enum":["top"]},{"type":"string","enum":["bottom"]}],"description":"Where to align the divider within its container."},"style":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The divider stroke color. A hex string (e.g. `#e0e0e0`), `rgb()` value, or theme reference."},"width":{"type":"number","description":"Stroke width in pixels."},"strokeStyle":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke style."}},"description":"The visual customization of the divider stroke, including width, style, and color."}}}],"description":"","title":"Divider"},{"type":"object","required":["id","kind","url"],"properties":{"id":{"type":"string","description":"The identifier of the embed."},"kind":{"type":"string","enum":["embed"]},"url":{"type":"string","description":"The URL to embed. Supports dynamic `{{formula}}` references."}},"description":"","title":"Embed"},{"allOf":[{"type":"object","required":["id","kind","source"],"properties":{"id":{"type":"string","description":"The identifier of the image."},"kind":{"type":"string","enum":["image"]},"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"alt":{"type":"string","description":"Alternative text for the image."},"style":{"allOf":[{"allOf":[{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}}},{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["rectangle"]},{"type":"string","enum":["circle"]}],"description":"The shape of the image."}}}]},{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}]}],"description":"The image display options, including fit, alignment, shape, and tiling."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Image"},{"allOf":[{"type":"object","required":["id","kind","source","inputMode"],"properties":{"id":{"type":"string","description":"The identifier of the input table element."},"kind":{"type":"string","enum":["input-table"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","connectionId"],"properties":{"kind":{"type":"string","enum":["empty"]},"connectionId":{"type":"string","description":"The identifier of the connection used to provision the input-table."}}},{"type":"object","properties":{"writebackSchema":{"type":"array","items":{"type":"string"},"description":"For connections with multiple writeback schemas (e.g. OAuth), the schema to provision the input-table into, given as the schema scope path — e.g. `[\"MY_DB\", \"MY_SCHEMA\"]`, or a single-element array on warehouses with a one-part path. Must match a writeback schema configured on the connection and accessible to the requesting user. Omit on single-schema connections to use the default. Create-time only."}}}]},{"allOf":[{"type":"object","required":["kind","from"],"properties":{"kind":{"type":"string","enum":["linked"]},"from":{"type":"string","description":"Id of another element in the spec whose data this input-table links to. Editable rows are matched to source rows by the `key` columns. The connection is inherited from that element."}}},{"type":"object","properties":{"writebackSchema":{"type":"array","items":{"type":"string"},"description":"For connections with multiple writeback schemas (e.g. OAuth), the schema to provision the input-table into, given as the schema scope path — e.g. `[\"MY_DB\", \"MY_SCHEMA\"]`, or a single-element array on warehouses with a one-part path. Must match a writeback schema configured on the connection and accessible to the requesting user. Omit on single-schema connections to use the default. Create-time only."}}}]}],"description":"The source of the input table. Set `kind` to `empty` with a `connectionId` to create a new table, or to `linked` with `from` to link to another element's data."},"inputMode":{"oneOf":[{"type":"string","enum":["edit"],"description":"Editable in the draft only, by users with Can edit access."},{"type":"string","enum":["explore"],"description":"Editable in the published version by users with Can explore or Can edit access."},{"type":"string","enum":["view"],"description":"Editable in the published version by users with Can view, Can explore, or Can edit access."}],"description":"The data entry permission for the input table. See the individual values for the access each one requires."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the input table. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"oneOf":[{"type":"string"},{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}}}],"description":"The description text for the input table, with optional styling."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The element style options, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"noDataText":{"type":"string","description":"The label displayed when the input table contains no data."},"tableComponents":{"type":"object","properties":{"table":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the input table body grid is shown. Set to `hidden` to hide it."},"summaryBar":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"The summary bar display options for the input table."}},"description":"The display options for the table grid and summary bar."},"tableStyle":{"allOf":[{"$ref":"#/components/schemas/TableStyle"}],"description":"The table style options, including grid preset, spacing, grid lines, banding, autofit, dividers, and text styles for headers and cells."},"columns":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"oneOf":[{"type":"string","enum":["ID"]},{"type":"string","enum":["CREATED_AT"]},{"type":"string","enum":["CREATED_BY"]},{"type":"string","enum":["UPDATED_AT"]},{"type":"string","enum":["UPDATED_BY"]}],"description":"The identifier of a system column. Data type is fixed."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]},{"allOf":[{"type":"object","required":["id","key"],"properties":{"id":{"type":"string","description":"The identifier of the key column in this input table."},"key":{"type":"string","description":"The identifier of the linked source column that this column's values must match. Cannot be changed after creation."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]},{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the warehouse column."},"type":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["datetime"]},{"type":"string","enum":["checkbox"]},{"type":"string","enum":["multi-select"]},{"type":"string","enum":["file"]}],"description":"Data type of the column."}}},{"type":"object","properties":{"values":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"description":"The allowed values for the column, presented as a dropdown. Cannot be specified if `valuesFrom` is specified."},"valuesFrom":{"type":"object","required":["element","column"],"properties":{"element":{"type":"string","description":"The identifier of the element that supplies the list of selectable options."},"column":{"type":"string","description":"The identifier of the column on the specified element to read values of selectable options from."}},"description":"The element and column supplying this column's option list. Cannot be specified if `values` is specified. Not valid alongside `range`."},"range":{"oneOf":[{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}},{"type":"object","properties":{"min":{"type":"string","description":"The selected date to filter on, in ISO 8601 format."},"max":{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}}}],"description":"Min/max bounds for a number or datetime column. Datetime bounds must be in ISO-8601 format. The range is inclusive."},"maxFileNum":{"type":"number","description":"Maximum number of files per cell (file columns only)."},"maxFileSizeMb":{"type":"number","description":"Maximum size per file in MB, 1–200 (file columns only)."},"acceptedFileTypes":{"type":"array","items":{"type":"string"},"description":"The allowed file MIME types. Defaults to all types. Passing any type of a MIME family (e.g. `application/msword`) selects the whole family. A round-trip expands the list to every type in the selected family."},"pills":{"oneOf":[{"type":"string","enum":["single-color"]},{"type":"string","enum":["color-by-option"]}],"description":"The display style of pills for select column options. Omit to show plain text."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]},{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the formula column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]}]},"description":"The columns in the input table."},"conditionalFormats":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["single"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","formula"],"properties":{"condition":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula for a conditional formatting rule. Can reference any column in the element. Must return a boolean."}}}]},{"type":"object","properties":{"style":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The cell background color, as a hex code."},"color":{"type":"string","description":"The font color, as a hex code."},"bold":{"type":"boolean"},"italic":{"type":"boolean"},"underline":{"type":"boolean"},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"Number or datetime override, in d3 format, for the displayed value. E.g., `#,##0.00` for thousands separators and two decimals."}}}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["backgroundScale"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The hex colors that define the gradient, as an array of 2 or more colors."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."},"mid":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The midpoint value for a diverging color scale. Omit for a sequential scale."}}},"order":{"oneOf":[{"type":"string","enum":["descending"]},{"type":"string","enum":["ascending"]}]},"nullBehavior":{"oneOf":[{"type":"string","enum":["asZero"]},{"type":"string","enum":["asNull"]}]},"steps":{"type":"number","description":"Quantize the continuous gradient into N discrete buckets."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fontScale"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The hex colors that define the gradient, as an array of 2 or more colors."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."},"mid":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The midpoint value for a diverging color scale. Omit for a sequential scale."}}},"order":{"oneOf":[{"type":"string","enum":["descending"]},{"type":"string","enum":["ascending"]}]},"nullBehavior":{"oneOf":[{"type":"string","enum":["asZero"]},{"type":"string","enum":["asNull"]}]},"steps":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["dataBars"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The hex colors that define the gradient, as an array of 2 or more colors."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."},"mid":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The midpoint value for a diverging color scale. Omit for a sequential scale."}}},"order":{"oneOf":[{"type":"string","enum":["descending"]},{"type":"string","enum":["ascending"]}]},"valueLabels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"string","enum":["shown"]}]}}}]}]},"description":"Conditional formatting rules applied to columns of this input table. Later rules take precedence over earlier rules."},"summary":{"type":"array","items":{"type":"string"},"description":"The identifiers of aggregate columns in the summary bar. Each identifier must also be defined in `columns`."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"The column, direction, and null placement used to sort rows. Supports multiple sort rules applied in order."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this input-table and their configurations."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}],"description":"","title":"Input Table"},{"allOf":[{"type":"object","required":["id","kind","pluginId"],"properties":{"id":{"type":"string","description":"The identifier of the plugin element."},"kind":{"type":"string","enum":["plugin"]},"pluginId":{"type":"string","description":"The identifier of the plugin to render in this element."}}},{"type":"object","properties":{"displayName":{"type":"string","description":"Display name for the plugin element."},"config":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"oneOf":[{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["element"]},"elementId":{"type":"string","description":"The element ID of the data source for this plugin."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"Which grouping level of the source element the plugin reads data from. Omit for ungrouped, row-level data."}}}],"description":"","title":"Element reference"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["column"]},"source":{"type":"string","description":"The name of the `config` entry that specifies an element reference (`kind: \"element\"`) that supplies the columns used by the plugin."}}},{"oneOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The identifier of a single column in the source element."}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of columns in the source element."}}}]}],"description":"","title":"Column reference"},{"type":"object","required":["kind","controlId"],"properties":{"kind":{"type":"string","enum":["control"]},"controlId":{"type":"string","description":"The control ID whose value feeds this configuration entry. E.g., `my-date-control`."}},"description":"","title":"Control reference"},{"type":"object","required":["kind","actionEffectId"],"properties":{"kind":{"type":"string","enum":["action-effect"]},"actionEffectId":{"type":"string","description":"The identifier of the action effect."}},"description":"","title":"Action effect reference"},{"type":"object","required":["kind","actionTriggerId"],"properties":{"kind":{"type":"string","enum":["action-trigger"]},"actionTriggerId":{"type":"string","description":"The identifier of the action trigger."}},"description":"","title":"Action trigger reference"}]}]},"description":"The inputs for the plugin, specified by the property names declared in the plugin. Property names are not validated by this API."},"style":{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"The element background color. A hex string (e.g. `#ffffff`), `rgb()` value, theme reference, or `transparent`."}},"description":"The visual styling of the plugin element."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered by this plugin's own `action-trigger` config entries."}}}],"description":"","title":"Plugin"},{"allOf":[{"type":"object","required":["id","kind"],"properties":{"id":{"type":"string","description":"The identifier of the progress element."},"kind":{"type":"string","enum":["progress"]}}},{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["bar"]},{"type":"string","enum":["ring"]}],"description":"Whether to render as a horizontal `bar` (default) or a `ring`."},"mode":{"oneOf":[{"type":"string","enum":["percent"]},{"type":"string","enum":["value"]}],"description":"The fill mode for progress. One of `percent` (value relative to min/max) or `value` (raw value). Defaults to `percent`."},"value":{"type":"string","description":"The formula for the current value. E.g. `Sum([Sales])` or `42`."},"min":{"type":"string","description":"The formula for the lower bound of the range. Only applies in value mode, where it defaults to `0`."},"max":{"type":"string","description":"The formula for the upper bound of the range. Only applies in value mode, where it defaults to the current value."},"config":{"type":"object","properties":{"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The element background, border, and padding."},"format":{"type":"object","properties":{"fillColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Color of the filled portion of the bar/ring."},"trackColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Color of the unfilled track behind the fill."},"size":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The thickness of the bar or diameter of the ring. Defaults to `medium`."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the bar or ring within the element."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the bar or ring within the element."}},"description":"The fill and track colors, size, and alignment of the bar or ring."},"label":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether this text is shown."},"text":{"type":"string","description":"Text content. Supports dynamic `{{formula}}` text."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size with the element."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The text color."}},"description":"The styling of the label text."},"value":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether this text is shown."},"text":{"type":"string","description":"Text content. Supports dynamic `{{formula}}` text."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size with the element."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The text color."}},"description":"The styling of the value text."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether this text is shown."},"text":{"type":"string","description":"Text content. Supports dynamic `{{formula}}` text."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"fontSize":{"oneOf":[{"type":"number"},{"type":"string","enum":["auto"]}],"description":"The font size in pixels, or `auto` to size with the element."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The text color."}},"description":"The styling of the description text."},"colorRules":{"type":"array","items":{"oneOf":[{"type":"object","required":["color","formula"],"properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The fill color applied when the formula is true."},"formula":{"type":"string","description":"The boolean formula that determines when the color applies."}}},{"allOf":[{"type":"object","required":["color"],"properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The fill color applied when the condition is true. Otherwise, the element's fill color applies."}}},{"oneOf":[{"type":"object","required":["condition","value"],"properties":{"condition":{"type":"string","enum":["=","!=",">",">=","<","<="]},"value":{"type":"number"}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"type":"string","enum":["Between","NotBetween"]},"low":{"type":"number"},"high":{"type":"number"}}}]},{"type":"object","properties":{"applyTo":{"oneOf":[{"type":"string","enum":["value"]},{"type":"string","enum":["percentage"]}],"description":"Whether to compare against the raw `value` (default) or filled `percentage`."}}}]}]},"description":"The conditional fill colors, evaluated top to bottom."}},"description":"The visual customization of the progress bar."}}}],"description":"","title":"Progress"},{"allOf":[{"type":"object","required":["id","kind","body"],"properties":{"id":{"type":"string","description":"The identifier of the text element."},"kind":{"type":"string","enum":["text"]},"body":{"type":"string","description":"Markdown body. Supports a deliberate subset: paragraphs, headings (#, ##, ###), bullet/ordered lists, soft and hard breaks, **bold**, *italic*, ~~strikethrough~~, [links](url) (open in a new window by default; use <a href=\"url\" target=\"_self\"> for same-window), inline HTML <u>/<sub>/<sup>/<span style=\"...\"> carrying any of color, background-color (hex), font-size (integer px), and font-family, plus {{formula}} segments (same {{ast | fmt}} syntax used by element titles). Paragraph alignment and the p-large/p-small block styles use a <p> wrapper, e.g. <p class=\"p-large\" style=\"text-align: center\">…</p> (aligned headings too: <p class=\"h-med\" style=\"text-align: center\">…</p>); unaligned headings stay #/##/### and default paragraphs stay bare. UI-authored features outside this subset (list-item color) come back as their closest supported neighbor on read."}}},{"type":"object","properties":{"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"Vertical alignment of text within the element. Defaults to `top`."},"overflow":{"oneOf":[{"type":"string","enum":["clip"]},{"type":"string","enum":["scroll"]}],"description":"Overflow behavior when content exceeds the element. Defaults to `clip`."}}}],"description":"","title":"Text"}]},"Form":{"allOf":[{"type":"object","required":["id","kind","fields"],"properties":{"id":{"type":"string","description":"The identifier of the form."},"kind":{"type":"string","enum":["form"]},"fields":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["fieldId","type"],"properties":{"fieldId":{"type":"string","description":"The identifier used to reference this field in formulas and actions."},"type":{"oneOf":[{"type":"string","enum":["short-text"]},{"type":"string","enum":["long-text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["checkbox"]}],"description":"A text, number, date, or checkbox input."}}},{"type":"object","properties":{"label":{"type":"string","description":"The label shown for the field."},"placeholder":{"type":"string","description":"Placeholder text shown while the field is empty."},"validation":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"min":{"type":"number","description":"The minimum allowed value."},"max":{"type":"number","description":"The maximum allowed value."}}}],"description":"","title":"Number range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"min":{"type":"string","description":"The earliest allowed date, in ISO 8601 format."},"max":{"type":"string","description":"The latest allowed date, in ISO 8601 format."}}}],"description":"","title":"Date range"},{"allOf":[{"type":"object","required":["kind","mode","value"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["matches-like-pattern"]},{"type":"string","enum":["does-not-match-like-pattern"]},{"type":"string","enum":["equals"]},{"type":"string","enum":["not-equals"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"How the entered text is compared against `value`. One of `contains`, `starts-with`, `ends-with`, `equals`, `matches-like-pattern`, `matches-regexp`, or their negations."},"value":{"type":"string","description":"The text string to match against."}}},{"type":"object","properties":{"caseSensitive":{"type":"boolean","description":"Whether the comparison is case-sensitive. Defaults to `false`."}}}],"description":"","title":"Text match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["file"]}}},{"type":"object","properties":{"maxFileSizeMb":{"type":"number","description":"The maximum size per file, in megabytes."},"acceptedFileTypes":{"type":"array","items":{"type":"string"},"description":"The allowed file MIME types. Defaults to all types. Passing any type of a MIME family (e.g. `application/msword`) selects the whole family. A round-trip expands the list to every type in the selected family."}}}],"description":"","title":"File"}],"description":"The validation rule for the field."},"hintText":{"type":"string","description":"Hint text shown beneath the field."}}},{"type":"object","properties":{"rules":{"type":"object","properties":{"readOnly":{"type":"string","enum":["read-only"],"description":"Set to `read-only` to prevent editing the field."},"requiredInput":{"type":"string","enum":["required"],"description":"Set to `required` when the field must be filled before the form is submitted."}},"description":"Rules that apply to the field."},"defaultValue":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["static"]},"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"A static default scalar value."},{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"boolean"}}],"description":"The pre-selected option for a single-select field, or an array of options for a multi-select field."}],"description":"The static initial value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"Formula text for the initial value."}}}],"description":"The field default value."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The number display format. Only applies to number fields."}}}],"description":"","title":"Simple field"},{"allOf":[{"type":"object","required":["fieldId","type"],"properties":{"fieldId":{"type":"string","description":"The identifier used to reference this field in formulas and actions."},"type":{"type":"string","enum":["file-upload"],"description":"A file-upload input."}}},{"type":"object","properties":{"label":{"type":"string","description":"The label shown for the field."},"placeholder":{"type":"string","description":"Placeholder text shown while the field is empty."},"validation":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"min":{"type":"number","description":"The minimum allowed value."},"max":{"type":"number","description":"The maximum allowed value."}}}],"description":"","title":"Number range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"min":{"type":"string","description":"The earliest allowed date, in ISO 8601 format."},"max":{"type":"string","description":"The latest allowed date, in ISO 8601 format."}}}],"description":"","title":"Date range"},{"allOf":[{"type":"object","required":["kind","mode","value"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["matches-like-pattern"]},{"type":"string","enum":["does-not-match-like-pattern"]},{"type":"string","enum":["equals"]},{"type":"string","enum":["not-equals"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"How the entered text is compared against `value`. One of `contains`, `starts-with`, `ends-with`, `equals`, `matches-like-pattern`, `matches-regexp`, or their negations."},"value":{"type":"string","description":"The text string to match against."}}},{"type":"object","properties":{"caseSensitive":{"type":"boolean","description":"Whether the comparison is case-sensitive. Defaults to `false`."}}}],"description":"","title":"Text match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["file"]}}},{"type":"object","properties":{"maxFileSizeMb":{"type":"number","description":"The maximum size per file, in megabytes."},"acceptedFileTypes":{"type":"array","items":{"type":"string"},"description":"The allowed file MIME types. Defaults to all types. Passing any type of a MIME family (e.g. `application/msword`) selects the whole family. A round-trip expands the list to every type in the selected family."}}}],"description":"","title":"File"}],"description":"The validation rule for the field."},"hintText":{"type":"string","description":"Hint text shown beneath the field."}}},{"type":"object","properties":{"rules":{"type":"object","properties":{"requiredInput":{"type":"string","enum":["required"],"description":"Set to 'required' when at least one file is required before submit."},"fileSelection":{"type":"string","enum":["multiple"],"description":"Set to 'multiple' when the field accepts multiple files."},"restrictNumberOfFiles":{"type":"number","description":"The maximum number of files allowed when `fileSelection` is `multiple`."}},"description":"Rules that apply to the field."},"defaultValue":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["static"]},"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"A static default scalar value."},{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"boolean"}}],"description":"The pre-selected option for a single-select field, or an array of options for a multi-select field."}],"description":"The static initial value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"Formula text for the initial value."}}}],"description":"The field default value."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The number display format. Only applies to number fields."}}}],"description":"","title":"File upload field"},{"allOf":[{"type":"object","required":["fieldId","type","source"],"properties":{"fieldId":{"type":"string","description":"The identifier used to reference this field in formulas and actions."},"type":{"oneOf":[{"type":"string","enum":["dropdown"]},{"type":"string","enum":["segmented-choice"]},{"type":"string","enum":["radio-group"]},{"type":"string","enum":["checkbox-group"]}],"description":"The type of choice input, such as a dropdown or a radio group."},"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["logical"]}],"description":"The data type of the choice values."}}},{"type":"object","properties":{"options":{"type":"array","items":{"allOf":[{"type":"object","required":["value"],"properties":{"value":{"oneOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}]}}},{"type":"object","properties":{"displayValue":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Optional display text for this option."}}}]},"description":"Manual values and their optional display values."}}}],"description":"","title":"Manual"},{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"","title":"Source"},{"type":"object","required":["kind","elementId","columnId"],"properties":{"kind":{"type":"string","enum":["input-table-column"]},"elementId":{"type":"string","description":"The input table element whose column supplies the options."},"columnId":{"type":"string","description":"The identifier of the column whose restricted values are the options."}},"description":"","title":"Input-table column"}],"description":"The source for options. Either a manual list or values from a column."}}},{"type":"object","properties":{"label":{"type":"string","description":"The label shown for the field."},"placeholder":{"type":"string","description":"Placeholder text shown while the field is empty."},"validation":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"min":{"type":"number","description":"The minimum allowed value."},"max":{"type":"number","description":"The maximum allowed value."}}}],"description":"","title":"Number range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"min":{"type":"string","description":"The earliest allowed date, in ISO 8601 format."},"max":{"type":"string","description":"The latest allowed date, in ISO 8601 format."}}}],"description":"","title":"Date range"},{"allOf":[{"type":"object","required":["kind","mode","value"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["matches-like-pattern"]},{"type":"string","enum":["does-not-match-like-pattern"]},{"type":"string","enum":["equals"]},{"type":"string","enum":["not-equals"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"How the entered text is compared against `value`. One of `contains`, `starts-with`, `ends-with`, `equals`, `matches-like-pattern`, `matches-regexp`, or their negations."},"value":{"type":"string","description":"The text string to match against."}}},{"type":"object","properties":{"caseSensitive":{"type":"boolean","description":"Whether the comparison is case-sensitive. Defaults to `false`."}}}],"description":"","title":"Text match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["file"]}}},{"type":"object","properties":{"maxFileSizeMb":{"type":"number","description":"The maximum size per file, in megabytes."},"acceptedFileTypes":{"type":"array","items":{"type":"string"},"description":"The allowed file MIME types. Defaults to all types. Passing any type of a MIME family (e.g. `application/msword`) selects the whole family. A round-trip expands the list to every type in the selected family."}}}],"description":"","title":"File"}],"description":"The validation rule for the field."},"hintText":{"type":"string","description":"Hint text shown beneath the field."}}},{"type":"object","properties":{"selection":{"oneOf":[{"type":"string","enum":["single"]},{"type":"string","enum":["multiple"]}],"description":"For a `dropdown` field, whether the dropdown is 'single' or 'multiple' selection."},"rules":{"type":"object","properties":{"readOnly":{"type":"string","enum":["read-only"],"description":"Set to `read-only` to prevent editing the field."},"requiredInput":{"type":"string","enum":["required"],"description":"Set to `required` when the field must be filled before the form is submitted."}},"description":"Rules that apply to the field."},"sort":{"type":"object","required":["by","direction"],"properties":{"by":{"oneOf":[{"type":"string","enum":["value"]},{"type":"string","enum":["count"]}],"description":"The sort order for options. One of `value` (alphanumeric) or `count` (frequency)."},"direction":{"oneOf":[{"type":"string","enum":["asc"]},{"type":"string","enum":["desc"]}],"description":"The sort direction."}},"description":"How the options are ordered. Defaults to ascending alphabetical."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"Option display format for number or date options."},"defaultValue":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["static"]},"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"A static default scalar value."},{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"boolean"}}],"description":"The pre-selected option for a single-select field, or an array of options for a multi-select field."}],"description":"The static initial value."}}},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"Formula text for the initial value."}}}],"description":"The field default value."}}}],"description":"","title":"Choice field"}]},"description":"The form fields, in display order."}}},{"type":"object","properties":{"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"Set to `'none'` to drop form padding."}}},{"type":"object","properties":{"backgroundColor":{"type":"string","description":"Form background color (hex)."},"corner":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"fieldGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether a gap between fields is shown. Defaults to `shown`."}}}]},{"type":"object","properties":{"backgroundColor":{"type":"string","description":"Form background color (hex)."},"corner":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"oneOf":[{"type":"number","enum":[0]},{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]}],"description":"Border width in pixels. `0` means no border."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"Border color (hex, rgb(), or theme reference)."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"fieldGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether a gap between fields is shown. Defaults to `shown`."}}}],"description":"Visual styling: background color, border, corners, padding, and field spacing."},"header":{"type":"object","properties":{"title":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the text is shown."},"text":{"type":"string","description":"The text content. Supports dynamic `{{formula}}` text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The text color."},"fontSize":{"type":"number","description":"The font size in pixels. One of `6` through `96`."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}},"description":"The form title and its styling."},"description":{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the text is shown."},"text":{"type":"string","description":"The text content. Supports dynamic `{{formula}}` text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The text color."},"fontSize":{"type":"number","description":"The font size in pixels. One of `6` through `96`."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight."}},"description":"The form description and its styling."}},"description":"The title and description configuration."},"fieldLabels":{"type":"object","properties":{"position":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["top"]}],"description":"The position of the field labels. Defaults to `top`."},"width":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"number","enum":[0.25]},{"type":"number","enum":[0.5]},{"type":"number","enum":[0.75]}],"description":"The width of the field label as a fraction of the field row."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The label color."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The label font weight."}},"description":"The field label placement and styling."},"footer":{"type":"object","properties":{"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]},{"type":"string","enum":["stretch"]}],"description":"The button row alignment."},"primary":{"type":"object","properties":{"label":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."},"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."}},"description":"The primary (submit) button. Defaults to \"Submit\"."},"secondary":{"type":"object","properties":{"label":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."},"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."}},"description":"The secondary (reset) button. Defaults to \"Reset form\"."},"tertiary":{"type":"object","properties":{"label":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."},"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."}},"description":"The tertiary button."}},"description":"The submit, reset, and tertiary button labels, visibility, and alignment."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}]},"IconName":{"type":"string","enum":["Accessibility","Action","Ai","AlignBottom","AlignCenterHorizontal","AlignCenterVertical","AlignLeft","AlignRight","AlignStretch","AlignTop","AlloyDb","Anchor","Api","ArrowDown","ArrowDownCircle","ArrowDownShort","ArrowLeft","ArrowLeftCircle","ArrowLeftShort","ArrowRight","ArrowRightCircle","ArrowRightShort","ArrowUp","ArrowUpCircle","ArrowUpDown","ArrowUpShort","At","Auto","Aws","AxisXBottom","AxisXTop","AxisYLeft","AxisYRight","Azure","Ban","BanCircle","Bars","Bell","BigQuery","Blank","Bold","Book","Bookmark","BordersAll","BordersDivider","BordersHorizontal","BordersNone","BordersVertical","Brand1","Brand2","Brand3","Brand4","Brand5","Brand6","BreakLink","Bricks","Bucket","BucketArrow","Button","Calendar","CaretDown","CaretUp","Check","CheckCircle","CheckDouble","CheckSquare","ChevronLargeDoubleDown","ChevronLargeDoubleLeft","ChevronLargeDoubleRight","ChevronLargeDoubleUp","ChevronLargeDown","ChevronLargeLeft","ChevronLargeRight","ChevronLargeUp","ChevronSmallDoubleDown","ChevronSmallDoubleLeft","ChevronSmallDoubleRight","ChevronSmallDoubleUp","ChevronSmallDown","ChevronSmallLeft","ChevronSmallRight","ChevronSmallUp","Circle","CircleSmall","Clickhouse","Clock","Cloud","CloudDownload","CloudUpload","Cold","ColumnMove","Compass","Confluence","Container","Controls","Copy","CornerPill","CornerRounded","CornerSquare","CrossOrg","Crosshairs","Dashboard","DataModel","Database","DatabaseMove","DatabaseSimple","Databricks","Dataset","Dbt","Desktop","Document","DocumentCsv","DocumentPdf","DocumentSql","Dollar","Download","DragHandle","DragShift","Dropdown","DropdownTrigger","Duplicate","EditorPython","EditorSql","EllipsisHorizontal","EllipsisVertical","EmailBurst","Embed","Envelope","EnvelopeBurst","EnvelopeOpen","Epsilon","EpsilonSquare","Eraser","Exclamation","ExclamationCircle","ExclamationOctagon","ExclamationSquare","ExclamationTriangle","ExpandPreview","Explore","Eye","EyeDropper","EyeSlash","Family","Flag","Folder","Form","FormatDecrease","FormatIncrease","FormatSeparateColumns","FormatSingleColumn","Funnel","Fx","Gear","Globe","GoogleAds","GoogleCloud","GoogleDrive","GoogleSheets","GridBlocks","GridDots","Header","Hierarchy","Highlight","Hightouch","Home","HorizonElementBlocks","HorizonElementCharts","HorizonElementControls","HorizonElementData","HorizonElementInput","HorizonElementLayout","HorizonElementUi","Hot","Image","InfoCircle","Italic","Join","Key","LayoutColumn","LayoutGroup","LayoutRow","LayoutStackHorizontal","LayoutStackVertical","Letter","Lightning","Limit","Line","Lineage","Link","List","ListBullets","ListCheck","ListNumbers","ListOverview","ListRadioButton","ListShapes","ListValue","ListYesNo","Lock","Logical","Lookup","MagnifyingGlass","MapExplore","MapPin","Mariadb","MarkSize","Materialization","Maximize","Mcp","Microphone","Microsoft","Minimize","Minus","MinusAlt","MinusCircle","MinusSquare","Mobile","Modal","ModalClose","ModalOpen","Moon","MsTeams","MySql","Number","NumberHierarchy","Octagon","Office","Offline","OpenNew","PageBreak","Pages","PaintBrush","PaintBucket","PaintRoller","PasswordReset","Pause","PauseCircle","Pencil","PeppermintAi","PeppermintBell","PeppermintChat","PeppermintDatabase","PeppermintFolder","PeppermintGear","PeppermintMagnifyingGlass","PeppermintPalette","PeppermintPencilBox","PeppermintPlus","PeppermintSidebar","PeppermintTemplate","Percent","Phi","Play","PlayCircle","PlayDesktop","PlugsElectronics","Plus","PlusCircle","PlusCircleSubtle","PlusSquare","PostgreSql","ProgressBar","ProgressRing","Puzzle","Python","QuestionCircle","RangeSlider","ReLink","Record","Rectangle","Redo","Redshift","Refresh","RefreshCircle","Reload","Replay","Report","Robot","RowPlus","RowX","Scissors","Section","SegmentedControl","Share","Sharepoint","Shortcut","Sidebar","SidebarHidden","SidebarVisible","Sigma","Slack","Slider","Snapshot","Snowflake","SortAscending","SortDescending","Spacer","SpeechBubble","Spin","SqlServer","Square","SquareSmall","Star","Starburst","Store","Strikethrough","Subscript","Sun","Superscript","Switch","Table","Tabs","Tags","Team","Text","TextAlignCenter","TextAlignLeft","TextAlignRight","TextArea","TextClip","TextColor","TextWrap","Textbox","TextboxNumber","ThumbsUp","TileClone","Tooltip","Transparent","Transpose","Trash","Trellis","Triangle","Trino","UnNest","Underline","Undo","Union","Unlock","Upload","Usage","User","UserCard","UserCircle","UserSwap","Variant","Vault","ViewExtend","VizArea","VizAreaStacked","VizAreaStackedPercent","VizAreaUnstacked","VizBarHorizontal","VizBarStacked","VizBarStackedPercent","VizBarUnstacked","VizBarVertical","VizBox","VizCombo","VizDonut","VizFunnel","VizGauge","VizHighlight","VizInputTable","VizInputTableLinked","VizKpi","VizLine","VizMap","VizPie","VizPivotTable","VizPlaceholder","VizSankey","VizScatter","VizSingleValue","VizTable","VizTreemap","VizWaterfall","Wand","Webhooks","Workbook","WorkbookForModifiers","WorkbookTemplate","Worksheet","Workspace","X","XCircle","XSquare"]},"Table":{"allOf":[{"type":"object","required":["id","kind","columns","source"],"properties":{"id":{"type":"string","description":"The identifier of the table."},"kind":{"type":"string","enum":["table"]},"columns":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The formula or column reference that defines the column's values."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Whether the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."}}},{"type":"object","properties":{"image":{"oneOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fixed"]}}},{"type":"object","properties":{"height":{"type":"number","description":"Fixed image cell height in pixels."},"width":{"type":"number","description":"Fixed image cell width in pixels."},"preserveAspectRatio":{"oneOf":[{"type":"string","enum":["preserve"]},{"type":"string","enum":["stretch"]}],"description":"How to size the image. Set to `preserve` to fit the image within the specified height and width while maintaining its aspect ratio. Set to `stretch` to fill the available dimensions."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["original"]}}}]},{"type":"null"}],"description":"Image display options for a text column containing URLs. Set to `null` to stop rendering the column as images."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The sparkline display options for the column."}}}]},{"type":"object","properties":{"style":{"type":"object","properties":{"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"Horizontal alignment of cell content: left, center, or right."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of cell content."},"width":{"type":"number","description":"The column width in pixels. Overrides auto-sizing."},"backgroundColor":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The cell background color. Either a theme reference (`{ kind: theme, ref }`) or a hex code (`#rgb` or `#rrggbb`)."},"color":{"oneOf":[{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string"}],"description":"The cell text color, as a hex code or theme reference."},"textWrap":{"oneOf":[{"type":"string","enum":["wrap"]},{"type":"string","enum":["clip"]}],"description":"The text overflow behavior."}},"description":"The grid presentation for this column, including alignment, width, colors, and text wrap."},"link":{"oneOf":[{"type":"object","required":["kind","columnId"],"properties":{"kind":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The identifier of the column of URLs. Required when `kind` is `column`."}}},{"type":"object","required":["kind","formula"],"properties":{"kind":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula that constructs the hyperlink URL. Must output Text data type. E.g., `Concat(\"https://example.com/?id=\", [Store Id])`."}}}],"description":"The hyperlink target for this column. Either another column containing URLs, or a formula that constructs one."}}}]},"description":"The columns of the table and their formulas."},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The source of the table."}}},{"type":"object","properties":{"name":{"oneOf":[{"type":"string","title":"Title text shorthand"},{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the title is shown. Set to `hidden` to hide it, overriding the default-shown behavior."}},"title":"Hidden title"},{"allOf":[{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"Title text. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The title font weight."},"fontSize":{"type":"number","description":"The title font size in pixels."},"align":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the title."}}}],"title":"Shown title"}],"description":"The title of the element. Supports dynamic `{{formula}}` text. Enter either a bare string for a plain title, an object with `text` and styling properties (font size, color, alignment, or weight) for a styled title, or `{ visibility: 'hidden' }` to hide the title."},"description":{"oneOf":[{"type":"string"},{"type":"object","properties":{"visibility":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the description is shown. Hiding a description does not remove the description text."},"text":{"type":"string","description":"The description text."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}],"description":"The font weight of the description."},"position":{"oneOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["below"]},{"type":"string","enum":["tooltip"]}],"description":"Where the description renders. Defaults to `auto`, which shows it as a subtitle on taller elements and as a tooltip on shorter ones."},"fontSize":{"type":"number","description":"Description font size in pixels."}}}],"description":"The table description, shown as a subtitle or tooltip."},"noDataText":{"type":"string","description":"Custom message rendered when the chart has no data."},"metrics":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the metric."},"formula":{"type":"string","description":"The formula defining the metric."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the metric."},"description":{"type":"string","description":"The description of the metric."},"isHighlighted":{"type":"boolean","description":"Whether the metric is highlighted."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"The display format of the column."},"timeline":{"allOf":[{"type":"object","required":["dateColumnId"],"properties":{"dateColumnId":{"type":"string","description":"The date column used for the metric timeline. Required when timeline is enabled."}}},{"type":"object","properties":{"truncation":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The precision to truncate the date to."},"comparison":{"allOf":[{"type":"object","required":["comparisonPeriod"],"properties":{"comparisonPeriod":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time period to compare the current metric value against."}}},{"type":"object","properties":{"direction":{"oneOf":[{"type":"string","enum":["higher-is-better"]},{"type":"string","enum":["lower-is-better"]}],"description":"Whether higher or lower comparison values are better for the metric."}}}],"description":"The time period to compare the current metric value against."}}}],"description":"The timeline display options for the metric."}}}]},"description":"The metrics defined for this table, each requiring an `id` and a `formula`."},"relationships":{"type":"array","items":{"allOf":[{"type":"object","required":["id","targetElementId","keys"],"properties":{"id":{"type":"string","description":"The identifier of the relationship."},"targetElementId":{"type":"string","description":"The identifier of the target table in the relationship."},"keys":{"type":"array","items":{"type":"object","required":["sourceColumnId","targetColumnId"],"properties":{"sourceColumnId":{"type":"string","description":"The column from the source element joined in this relationship."},"targetColumnId":{"type":"string","description":"The column from the target table joined in this relationship."}}},"description":"The source and target column ID pairs that define the join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the relationship."},"description":{"type":"string","description":"The description of the relationship."}}}]},"description":"The relationships sourced from this table. Each relationship defines a join to a target table."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against the filter pattern."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this table and their configurations."},"folders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the folder."},"name":{"type":"string","description":"The name of the folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns and folders the folder contains."}}}]},"description":"The folders in the table and their contents."},"groupings":{"type":"array","items":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the grouping."}}},{"type":"object","properties":{"groupBy":{"type":"array","items":{"type":"string"},"description":"The columns or folders that define the grouping. Rows sharing the same values in these columns are grouped together for aggregate calculations."},"calculations":{"type":"array","items":{"type":"string"},"description":"The calculations applied to the grouping."}}}]},"description":"The groupings in the table."},"summary":{"type":"array","items":{"type":"string"},"description":"The identifiers of all summary columns in the table."},"order":{"type":"array","items":{"type":"string"},"description":"A list of identifiers that determines the order in which columns and folders are displayed. Does not include summary columns."},"visibleAsSource":{"type":"boolean","description":"Whether the table can be used as a data source in other documents."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"The columns, directions, and null placement used to sort the table's rows. Each `columnId` must reference an existing column, with no duplicates."},"columnSecurities":{"type":"array","items":{"type":"object","required":["id","restrictedColumns","criteria"],"properties":{"id":{"type":"string","description":"The identifier of the column security rule."},"restrictedColumns":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns restricted by this rule. Each must be the id of a column on the table."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"description":"","title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"description":"","title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"description":"","title":"Team"}]},"description":"The identifiers of the users and teams allowed to view the columns."}},"description":"","title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of the user attribute that controls access to this column."},"value":{"type":"string","description":"The user attribute value required to view the restricted columns. Users assigned this value can access the columns."}}},"description":"The identifier of the user attribute and the value required to view columns restricted by this rule. Users assigned this value can access the protected columns."}},"description":"","title":"User Attribute"}]}}},"description":"The column security rules applied to columns in this table."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"customContextMenu":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","displayName","menuItems"],"properties":{"type":{"type":"string","enum":["group"]},"id":{"type":"string","description":"Stable identifier for this submenu group."},"displayName":{"type":"string","description":"Label shown for this submenu in the element's right-click context menu."},"menuItems":{"type":"array","items":{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]},"description":"Items nested inside this submenu. Groups cannot contain further groups (one level of nesting only)."}}},{"allOf":[{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","description":"Stable identifier for this menu item, chosen by the author. Referenced by an on-context-menu-click action trigger."},"displayName":{"type":"string","description":"Label shown for this item in the element's right-click context menu."}}},{"type":"object","properties":{"type":{"type":"string","enum":["item"],"description":"Discriminant for this entry; defaults to 'item' when omitted."}}}]}]},"description":"Custom items shown in this element's right-click context menu."},"conditionalFormats":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["single"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","formula"],"properties":{"condition":{"type":"string","enum":["formula"]},"formula":{"type":"string","description":"The formula for a conditional formatting rule. Can reference any column in the element. Must return a boolean."}}}]},{"type":"object","properties":{"style":{"type":"object","properties":{"backgroundColor":{"type":"string","description":"The cell background color, as a hex code."},"color":{"type":"string","description":"The font color, as a hex code."},"bold":{"type":"boolean"},"italic":{"type":"boolean"},"underline":{"type":"boolean"},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The number format string in d3 format syntax. E.g., `.2s` for SI notation with two significant digits (1.2k) or `#x` for prefixed hexadecimal (0x4d3)."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix appended to the number. E.g., `'%'` or `'units'`."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The number of digits between grouping symbols."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date, specified in d3 time format."}}}]}],"description":"Number or datetime override, in d3 format, for the displayed value. E.g., `#,##0.00` for thousands separators and two decimals."}}}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["backgroundScale"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The hex colors that define the gradient, as an array of 2 or more colors."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."},"mid":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The midpoint value for a diverging color scale. Omit for a sequential scale."}}},"order":{"oneOf":[{"type":"string","enum":["descending"]},{"type":"string","enum":["ascending"]}]},"nullBehavior":{"oneOf":[{"type":"string","enum":["asZero"]},{"type":"string","enum":["asNull"]}]},"steps":{"type":"number","description":"Quantize the continuous gradient into N discrete buckets."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["fontScale"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The hex colors that define the gradient, as an array of 2 or more colors."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."},"mid":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The midpoint value for a diverging color scale. Omit for a sequential scale."}}},"order":{"oneOf":[{"type":"string","enum":["descending"]},{"type":"string","enum":["ascending"]}]},"nullBehavior":{"oneOf":[{"type":"string","enum":["asZero"]},{"type":"string","enum":["asNull"]}]},"steps":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["dataBars"]}}},{"type":"object","required":["columnIds"],"properties":{"columnIds":{"type":"array","items":{"type":"string"},"description":"The identifiers of the columns this conditional formatting rule applies to. Each must be the id of a column on the element."}}},{"type":"object","properties":{"scheme":{"type":"array","items":{"type":"string"},"description":"The hex colors that define the gradient, as an array of 2 or more colors."},"domain":{"type":"object","properties":{"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The minimum of the scale domain. A number, or a formula that evaluates to a number."},"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The maximum of the scale domain. A number, or a formula that evaluates to a number."},"mid":{"oneOf":[{"type":"number"},{"type":"string"}],"description":"The midpoint value for a diverging color scale. Omit for a sequential scale."}}},"order":{"oneOf":[{"type":"string","enum":["descending"]},{"type":"string","enum":["ascending"]}]},"valueLabels":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"string","enum":["shown"]}]}}}]}]},"description":"Conditional formatting rules applied to columns of this table. Later rules take precedence over earlier ones."},"sparkline":{"type":"object","properties":{"shape":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["bar"]}],"description":"The sparkline chart type."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"interpolation":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["monotone"]},{"type":"string","enum":["step"]},{"type":"string","enum":["step-before"]},{"type":"string","enum":["step-after"]}],"description":"The line interpolation method."},"missing":{"oneOf":[{"type":"string","enum":["zero"]},{"type":"string","enum":["interpolate"]},{"type":"string","enum":["hide"]}],"description":"How null values are drawn between points. One of `interpolate` (bridged), `hide` (omitted), or `zero` (plotted as zero)."},"line":{"type":"object","properties":{"style":{"oneOf":[{"type":"string","enum":["solid"]},{"type":"string","enum":["dashed"]},{"type":"string","enum":["dotted"]}],"description":"The stroke pattern."},"width":{"oneOf":[{"type":"number","enum":[1]},{"type":"number","enum":[2]},{"type":"number","enum":[3]},{"type":"number","enum":[4]},{"type":"number","enum":[5]}],"description":"Stroke width in pixels (1–5)."}},"description":"The line stroke style and width for line-shaped sparklines."},"tooltip":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the sparkline displays a hover tooltip with x and y values."},"points":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether points are shown. Set to `hidden` to hide them. Cannot be combined with `shape` or `size`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Whether to show points. Set to `shown` to display them."},"shape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle-up"]}],"description":"The point shape."},"size":{"oneOf":[{"type":"number","enum":[4]},{"type":"number","enum":[9]},{"type":"number","enum":[16]},{"type":"number","enum":[25]},{"type":"number","enum":[36]},{"type":"number","enum":[64]},{"type":"number","enum":[100]},{"type":"number","enum":[144]},{"type":"number","enum":[225]}],"description":"The point size by area scale, when no size field is set."}}}],"description":"The point display options for line sparklines."},"labels":{"oneOf":[{"type":"object","required":["visibility"],"properties":{"visibility":{"type":"string","enum":["hidden"],"description":"Whether the endpoint labels are shown. Set to `hidden` to hide them. Cannot be combined with `color` or `fontSize`."}}},{"type":"object","properties":{"visibility":{"type":"string","enum":["shown"],"description":"Set to `shown` to display endpoint labels. Endpoint labels display the first and last `x, y` value pairs for each sparkline."},"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Label font size in pixels."}}}],"description":"Endpoint value labels on line sparklines."}},"description":"The mark formatting applied to sparkline columns."},"tableComponents":{"type":"object","description":"Whether table components are shown, such as the summary bar and collapsed columns. Defaults to `shown`."},"tableStyle":{"allOf":[{"$ref":"#/components/schemas/TableStyle"}],"description":"The table style options, including grid preset, spacing, grid lines, banding, autofit, dividers, and text styles for headers and cells."},"frozenColumn":{"oneOf":[{"allOf":[{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The column to freeze. This column and any column visually to its left are frozen."}}},{"type":"object","properties":{"fieldValues":{"type":"array","items":{"type":"object","required":["fieldId","value"],"properties":{"fieldId":{"type":"string","description":"Pivot shelf field id for a dimension value at the freeze point."},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"description":"Dimension member value at the freeze point."}}},"description":"The pivot dimension values identifying which repeated column to freeze. Each value must match its column’s data type."}}}]},{"type":"null"}],"description":"The frozen column configuration. Freezes this column and all columns to its left, keeping them visible when scrolling right."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by interacting with this element."}}}]},"Control":{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["checkbox"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The toggle mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"Whether the control is selected."}}}]}],"description":"","title":"Checkbox"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["switch"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The toggle mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"Whether the control is selected."}}}]}],"description":"","title":"Switch"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"The type of text comparison to make."}}},{"type":"object","properties":{"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Whether the text comparison is case sensitive."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."},"showOperators":{"type":"boolean","description":"Whether the comparison-mode picker is shown in the control, letting viewers change how the mode compares text."},"value":{"type":"string","description":"The text entered in the control. Defaults to `empty`."}}}],"description":"","title":"Text"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text-area"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"value":{"type":"string","description":"The text entered in the control. Defaults to `empty`."}}}],"description":"","title":"Text Area"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter numbers."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number entered in the control."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Number"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter dates."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The date selected in the control, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Date"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}],"description":"","title":"Date Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["file-upload"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"acceptedFileTypes":{"type":"array","items":{"type":"string"},"description":"Allowed file extensions (e.g. jpg, pdf); absent or empty accepts all supported types."},"maxFileNum":{"type":"number","description":"Maximum number of files (≥ 1). `1` limits each upload to a single file."},"maxFileSizeMb":{"type":"number","description":"Maximum size per file in MB, 1–200."}}}],"description":"","title":"File Upload"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["top-n"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The ranking function used by the filter."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Whether to filter the top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."}}}]},{"type":"object","required":["source"],"properties":{"source":{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}]}]},{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."}}}]},{"type":"object","properties":{"source":{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control. For manual controls, specify each value and optionally a display label."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The display labels applied to the control's values. E.g., \"Q1\" and \"Q2\" for values 1 and 2."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}]}]}],"description":"","title":"List values"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["segmented"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"clearLabel":{"type":"string","description":"The label for the clear option, shown only when `showClearLabel` is `true`. Defaults to `None`."},"showClearLabel":{"type":"boolean","description":"Whether a clear option is shown in the control. Defaults to `false`."},"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control. For manual controls, specify each value and optionally a display label."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The display labels applied to the control's values. E.g., \"Q1\" and \"Q2\" for values 1 and 2."}}}],"description":"","title":"Manual"},{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"","title":"Source"}],"description":"The source of the control's possible values. References a column from a data element or data source, or a manual list with custom values."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}],"description":"","title":"Segmented Control"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"source":{"type":"object","required":["source","columnId"],"properties":{"source":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},"columnId":{"type":"string"}}},"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Whether the selected values are included or excluded by the filter. Defaults to `include`."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}}],"description":"","title":"Hierarchy"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["drill"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","required":["columnId"],"properties":{"columnId":{"type":"string","description":"The identifier of a column in the drill path, in order from outer to inner level."}}},"description":"The ordered drill path columns from the value source."},"source":{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"The value source and anchor column for the drill path."},"targets":{"type":"array","items":{"type":"object","required":["source","columnIds"],"properties":{"source":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"The target visualization."},"columnIds":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The column IDs for each drill category, in category order."}}},"description":"The visualizations this control drills into."},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The selected drill category column id."}}}],"description":"","title":"Drill down"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["legend"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control. For manual controls, specify each value and optionally a display label."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The display labels applied to the control's values. E.g., \"Q1\" and \"Q2\" for values 1 and 2."}}}],"description":"","title":"Manual"},{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"","title":"Source"}],"description":"The source of the control's possible values. References a column from a data element or data source, or a manual list with custom values."}}},{"type":"object","properties":{"colorAssignment":{"type":"object","properties":{"customColors":{"type":"array","items":{"type":"object","required":["color","value"],"properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"value":{"oneOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"type":"null"}],"description":"The legend value to assign this color."}}},"description":"The color assignments for individual legend values."},"palette":{"type":"object","required":["scheme","type"],"properties":{"scheme":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A named theme palette or list of custom hex colors."},"type":{"type":"string","enum":["categorical"]}}}}},"legend":{"type":"object","properties":{"fontSize":{"type":"number","description":"Legend label font size in pixels."},"markShape":{"oneOf":[{"type":"string","enum":["circle"]},{"type":"string","enum":["square"]},{"type":"string","enum":["cross"]},{"type":"string","enum":["diamond"]},{"type":"string","enum":["triangle"]},{"type":"string","enum":["solid-line"]},{"type":"string","enum":["dashed-line"]},{"type":"string","enum":["dotted-line"]}],"description":"The shape of the legend marks. Defaults to `square`."},"orientation":{"oneOf":[{"type":"string","enum":["vertical"]},{"type":"string","enum":["horizontal"]},{"type":"string","enum":["horizontal-with-wrap"]}],"description":"The legend control orientation. Defaults to `vertical`."},"textColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."}}},"nullValues":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether null is a selectable value. Defaults to `shown`."},"otherCategories":{"oneOf":[{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["use-legend-palette"]}}},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["use-other-color"]}}},{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"label":{"type":"string","description":"Label for grouped unlisted values."}}}]}]},"targets":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The chart legend columns targeted by this control. Only charts with color set by category can be targeted."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values."}}}],"description":"","title":"Legend"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter numbers."}}},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number selected in the control. For range sliders, reference the minimum and maximum values with `.min` and `.max`."}}}],"description":"","title":"Slider"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["range-slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name. Supports dynamic `{{formula}}` text, and optional d3 formatting via pipe, e.g. `\"Total: {{Count() | ,.0f}}\"`."},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The workbook element or data source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column targeted by this control."}}},"description":"The filter targets of the control."},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this workbook control passes its value to as a parameter."},"style":{"oneOf":[{"allOf":[{"type":"object","required":["padding"],"properties":{"padding":{"type":"string","enum":["none"],"description":"The padding around the element. Set to none to remove padding. `borderWidth` and `borderColor` cannot be set alongside it."}}},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."}}}]},{"type":"object","properties":{"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}},{"type":"string","enum":["transparent"]}],"description":"Element background color (hex, rgb(), theme reference, or \"transparent\")."},"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"borderWidth":{"type":"number","description":"The border width, in pixels. Cannot be set when `padding` is `none`."},"borderColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The border color. A hex code, `rgb()` value, or theme reference. Cannot be set when `padding` is `none`."}}}],"description":"The visual styling, including background color, border, corner shape, and padding."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions triggered when this control's value changes."}}}]},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"When to include null values in the filter results."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Range Slider"},{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of this synced copy."},"controlId":{"type":"string","description":"The identifier of the control this copy is synced with."},"controlType":{"type":"string","enum":["synced"]}},"description":"","title":"Synced"}]}}},"security":[{"oauth2":[]}],"paths":{"/v2/accountTypes":{"get":{"summary":"List account types","description":"Returns a list of all account types available in the organization.\n\n  ### Usage notes\n  - Use the **accountTypeId** with the [/v2/accountTypes/:accountTypeId/permissions](https://help.sigmacomputing.com/reference/list-account-type-permissions) endpoint to retrieve more detailed permissions.\n  - **licenseType** depends on the permissions enabled for the account type.\n  - To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n\n  ### Usage scenarios\n  - Display available account types in an admin interface.\n  - Show an overview of account types for management.\n  ","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listAccountTypes","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["accountTypeId","accountTypeName","description","isCustom","licenseType"],"properties":{"accountTypeId":{"type":"string","description":"The unique identifier of the account type."},"accountTypeName":{"type":"string","description":"The name of the account type."},"description":{"type":"string","description":"A human-readable description of the permissions and capabilities provided by this account type."},"isCustom":{"type":"boolean","description":"Whether this is a custom account type created by the organization (true) or a default Sigma account type (false)."},"licenseType":{"type":"string","description":"The license type of the account type."}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["accountTypes"]},"post":{"summary":"Create an account type","description":"Create a custom account type with specified permissions.\n\n  ### Usage notes\n  - To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n  - Use the permission names from the [/v2/accountTypes/:accountTypeId/permissions](https://help.sigmacomputing.com/reference/list-account-type-permissions) endpoint.\n  - **licenseType** depends on the permissions enabled for the account type.\n\n  ### Usage scenarios\n  - Create custom account types to define specific permission sets for your organization's users.\n  ","parameters":[],"operationId":"createAccountType","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["name","description","permissions"],"properties":{"name":{"type":"string","description":"The name of the account type."},"description":{"type":"string","description":"A description of the account type."},"permissions":{"type":"array","items":{"type":"string"},"description":"An array of permissions to enable for this account type. Use the permission names from the [/v2/accountTypes/:accountTypeId/permissions](https://help.sigmacomputing.com/reference/list-account-type-permissions) endpoint."}}}}}},"responses":{"201":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["accountTypeId","accountTypeName","description","isCustom","licenseType"],"properties":{"accountTypeId":{"type":"string","description":"The unique identifier of the account type."},"accountTypeName":{"type":"string","description":"The name of the account type."},"description":{"type":"string","description":"A human-readable description of the permissions and capabilities provided by this account type."},"isCustom":{"type":"boolean","description":"Whether this is a custom account type created by the organization (true) or a default Sigma account type (false)."},"licenseType":{"type":"string","description":"The license type of the account type."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["accountTypes"]}},"/v2/accountTypes/{accountTypeId}":{"delete":{"summary":"Delete an account type","description":"Delete a custom account type and reassign its users to another account type.\n\n  ### Usage notes\n  - To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n  - Default Sigma account types cannot be deleted.\n  - All users assigned to the deleted account type will be reassigned to the specified **reassignToAccountTypeId**.\n  - Retrieve account type IDs by calling the [/v2/accountTypes](https://help.sigmacomputing.com/reference/list-account-types) endpoint.\n\n  ### Usage scenarios\n  - Remove custom account types that are no longer needed.\n  - Consolidate account types by moving users to a different account type before deletion.\n  ","parameters":[{"name":"accountTypeId","schema":{"type":"string","description":"The unique identifier of the account type to delete."},"in":"path","required":true},{"name":"reassignToAccountTypeId","schema":{"type":"string","description":"The unique identifier of the account type to reassign users to. Users currently assigned the deleted account type will be reassigned this account type."},"in":"query"}],"operationId":"deleteAccountType","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["accountTypes"]}},"/v2/accountTypes/{accountTypeId}/permissions":{"get":{"summary":"List account type permissions","description":"Returns all feature permissions for a specific account type.\n\n  ### Usage notes\n  - Retrieve the **accountTypeId** by calling the [/v2/accountTypes](https://help.sigmacomputing.com/reference/list-account-types) endpoint.\n  - To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n\n  ### Usage scenarios\n  - Display permission details in an admin interface.\n  - Validate user capabilities based on account type.\n  - Compare permissions across different account types.\n  ","parameters":[{"name":"accountTypeId","schema":{"type":"string","description":"The unique identifier of the account type."},"in":"path","required":true}],"operationId":"listAccountTypePermissions","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["permission","description"],"properties":{"permission":{"type":"string","description":"The permission name. For example, \"view-worksheet\"."},"description":{"type":"string","description":"A human-readable description of what this permission allows."}}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["accountTypes"]},"patch":{"summary":"Update account type permissions","description":"Add or remove permissions on a custom account type.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update permissions for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.\n- Retrieve the **accountTypeId** by calling the [/v2/accountTypes](https://help.sigmacomputing.com/reference/list-account-types) endpoint.\n- For **add** and **remove**, use the permission names from the response of the [/v2/accountTypes/:accountTypeId/permissions](https://help.sigmacomputing.com/reference/list-account-type-permissions).\n- A permission cannot appear in both **add** and **remove**.\n- You cannot modify the permissions of the Admin account type.\n- **licenseType** depends on the permissions enabled for the account type.\n- **permissions** is the account type's full permission set after applying this update.\n\n### Usage scenarios\n- Enable or disable specific permissions for a custom account type.\n","parameters":[{"name":"accountTypeId","schema":{"type":"string","description":"The unique identifier of the account type."},"in":"path","required":true}],"operationId":"updateAccountTypePermissions","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"add":{"type":"array","items":{"type":"string"},"description":"Permissions to turn on for this account type."},"remove":{"type":"array","items":{"type":"string"},"description":"Permissions to turn off for this account type."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["accountTypeId","accountTypeName","description","isCustom","licenseType"],"properties":{"accountTypeId":{"type":"string","description":"The unique identifier of the account type."},"accountTypeName":{"type":"string","description":"The name of the account type."},"description":{"type":"string","description":"A human-readable description of the permissions and capabilities provided by this account type."},"isCustom":{"type":"boolean","description":"Whether this is a custom account type created by the organization (true) or a default Sigma account type (false)."},"licenseType":{"type":"string","description":"The license type of the account type."}}},{"type":"object","required":["permissions"],"properties":{"permissions":{"type":"array","items":{"type":"object","required":["permission","description"],"properties":{"permission":{"type":"string","description":"The permission name. For example, \"view-worksheet\"."},"description":{"type":"string","description":"A human-readable description of what this permission allows."}}},"description":"The account type's full set of permissions after applying this update."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["accountTypes"]}},"/v2/api-connectors":{"get":{"summary":"List API connectors","description":"This endpoint returns a paginated list of API connectors. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- Only returns API connectors that the user making this request has at least **Can view** access to.\n- Use the `name` query parameter to filter by connector name.\n- Use the `orderBy` query parameter to set sort order.\n\n### Usage scenarios\n- **Connector discovery:** Retrieve a list of available API connectors available to users configuring **Call API** actions.\n- **Connector management:** View and audit the organization's API connectors.","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"},{"name":"orderBy","schema":{"type":"string","description":"Sort order. Supported fields: `name`, `description`. Append ` desc` for descending (e.g. `name desc`). Defaults to `name` ascending.","title":"Order by"},"in":"query"},{"name":"name","schema":{"type":"string","description":"Filter results to connectors whose name contains this substring."},"in":"query"}],"operationId":"listApiConnectors","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["apiConnectorId","name","description"],"properties":{"apiConnectorId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-connectors"]},"post":{"summary":"Create an API connector","description":"This endpoint creates a new API connector that defines how to call an external HTTP endpoint from within Sigma. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- The user making this request must be assigned an account type with the **Manage API connectors** permission enabled.\n- If a credential is provided using the `authId` parameter, the user making this request must have at least **Can view** permission on the credential and the request URL must match the credential's allowlist.\n- Retrieve the **apiCredentialId** (used as `authId`) by calling the [/v2/api-credentials](https://help.sigmacomputing.com/reference/list-api-credentials) endpoint.\n\n### Usage scenarios\n- **Programmatic connector setup:** Automate creation of API connectors as part of an environment provisioning workflow.\n- **Integration onboarding:** Create connectors for each external service your workbooks need to interact with.","parameters":[],"operationId":"createApiConnector","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name","params"],"properties":{"name":{"type":"string","description":"Display name of the connector."},"params":{"type":"object","required":["method","url","headers","pathParams","queryParams","body"],"properties":{"method":{"type":"string","enum":["GET","POST","DELETE","PATCH","PUT","OPTIONS","HEAD"],"description":"HTTP method to invoke."},"url":{"type":"string","description":"Request URL. Must resolve to a hostname matching the associated credential's allowlist."},"headers":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Static or dynamic request headers."},"pathParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Path parameter placeholders resolved into the URL."},"queryParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Query string parameters."},"body":{"type":"string","description":"Raw request body template."}}}}},{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description."},"config":{"type":"object","properties":{"timeout":{"type":"object","required":["requestSec"],"properties":{"requestSec":{"type":"number"}},"description":"Per-request timeout configuration."},"retry":{"type":"object","required":["maxRetries","retryableStatusCodes"],"properties":{"maxRetries":{"type":"number"},"retryableStatusCodes":{"type":"array","items":{"type":"number"}}},"description":"Retry policy. `retryableStatusCodes` are HTTP codes that should trigger a retry."},"redirects":{"type":"object","required":["maxRedirects"],"properties":{"maxRedirects":{"type":"number"}},"description":"HTTP redirect handling."},"rateLimit":{"type":"object","required":["maxRequestsPerWindow"],"properties":{"maxRequestsPerWindow":{"type":"number"}},"description":"Rate limit applied to outbound requests from this connector."}}},"authId":{"type":"string","description":"Identifier of the API credential (`apiCredentialId`) used to authenticate requests."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["apiConnectorId","name","params","config"],"properties":{"apiConnectorId":{"type":"string","description":"Unique identifier of the API connector."},"name":{"type":"string","description":"Display name of the connector."},"params":{"allOf":[{"type":"object","required":["method","url","headers","pathParams","queryParams","body"],"properties":{"method":{"type":"string","enum":["GET","POST","DELETE","PATCH","PUT","OPTIONS","HEAD"],"description":"HTTP method to invoke."},"url":{"type":"string","description":"Request URL. Must resolve to a hostname matching the associated credential's allowlist."},"headers":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Static or dynamic request headers."},"pathParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Path parameter placeholders resolved into the URL."},"queryParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Query string parameters."},"body":{"type":"string","description":"Raw request body template."}}},{"type":"object","required":["bodyParams"],"properties":{"bodyParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Dynamic parameters extracted from `body`."}}}]},"config":{"type":"object","required":["timeout","retry","redirects","rateLimit"],"properties":{"timeout":{"type":"object","required":["requestSec"],"properties":{"requestSec":{"type":"number"}},"description":"Per-request timeout configuration."},"retry":{"type":"object","required":["maxRetries","retryableStatusCodes"],"properties":{"maxRetries":{"type":"number"},"retryableStatusCodes":{"type":"array","items":{"type":"number"}}},"description":"Retry policy. `retryableStatusCodes` are HTTP codes that should trigger a retry."},"redirects":{"type":"object","required":["maxRedirects"],"properties":{"maxRedirects":{"type":"number"}},"description":"HTTP redirect handling."},"rateLimit":{"type":"object","required":["maxRequestsPerWindow"],"properties":{"maxRequestsPerWindow":{"type":"number"}},"description":"Rate limit applied to outbound requests from this connector."}}}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description."},"authId":{"type":["string","null"],"description":"Identifier of the API credential (`apiCredentialId`) used to authenticate requests. `null` if unauthenticated."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-connectors"]}},"/v2/api-connectors/{apiConnectorId}":{"get":{"summary":"Get an API connector","description":"This endpoint returns full details for a single API connector, including its request parameters and configuration. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- Only returns API connectors that the user making this request has at least **Can view** access to.\n- Retrieve the **apiConnectorId** by calling the [/v2/api-connectors](https://help.sigmacomputing.com/reference/list-api-connectors) endpoint.\n\n### Usage scenarios\n- **Connector inspection:** Retrieve the full configuration of a connector for display or validation before use.\n- **Connector duplication:** Read an existing connector's configuration to use as the basis for a new one.","parameters":[{"name":"apiConnectorId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getApiConnector","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["apiConnectorId","name","params","config"],"properties":{"apiConnectorId":{"type":"string","description":"Unique identifier of the API connector."},"name":{"type":"string","description":"Display name of the connector."},"params":{"allOf":[{"type":"object","required":["method","url","headers","pathParams","queryParams","body"],"properties":{"method":{"type":"string","enum":["GET","POST","DELETE","PATCH","PUT","OPTIONS","HEAD"],"description":"HTTP method to invoke."},"url":{"type":"string","description":"Request URL. Must resolve to a hostname matching the associated credential's allowlist."},"headers":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Static or dynamic request headers."},"pathParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Path parameter placeholders resolved into the URL."},"queryParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Query string parameters."},"body":{"type":"string","description":"Raw request body template."}}},{"type":"object","required":["bodyParams"],"properties":{"bodyParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Dynamic parameters extracted from `body`."}}}]},"config":{"type":"object","required":["timeout","retry","redirects","rateLimit"],"properties":{"timeout":{"type":"object","required":["requestSec"],"properties":{"requestSec":{"type":"number"}},"description":"Per-request timeout configuration."},"retry":{"type":"object","required":["maxRetries","retryableStatusCodes"],"properties":{"maxRetries":{"type":"number"},"retryableStatusCodes":{"type":"array","items":{"type":"number"}}},"description":"Retry policy. `retryableStatusCodes` are HTTP codes that should trigger a retry."},"redirects":{"type":"object","required":["maxRedirects"],"properties":{"maxRedirects":{"type":"number"}},"description":"HTTP redirect handling."},"rateLimit":{"type":"object","required":["maxRequestsPerWindow"],"properties":{"maxRequestsPerWindow":{"type":"number"}},"description":"Rate limit applied to outbound requests from this connector."}}}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description."},"authId":{"type":["string","null"],"description":"Identifier of the API credential (`apiCredentialId`) used to authenticate requests. `null` if unauthenticated."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-connectors"]},"patch":{"summary":"Update an API connector","description":"This endpoint updates one or more fields on an existing API connector. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- Retrieve the **apiConnectorId** by calling the [/v2/api-connectors](https://help.sigmacomputing.com/reference/list-api-connectors) endpoint.\n- The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and must have **Can edit** access to the connector.\n- Omitted fields are left unchanged. Pass `null` for `authId` to remove the credential association.\n\n### Usage scenarios\n- **Endpoint migration:** Update the connector URL or parameters when an external API changes its interface.\n- **Credential rotation:** Rebind the connector to a new credential after rotating secrets.","parameters":[{"name":"apiConnectorId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateApiConnector","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New display name."},"description":{"type":["string","null"],"description":"New description. Pass `null` to clear."},"params":{"type":"object","required":["method","url","headers","pathParams","queryParams","body"],"properties":{"method":{"type":"string","enum":["GET","POST","DELETE","PATCH","PUT","OPTIONS","HEAD"],"description":"HTTP method to invoke."},"url":{"type":"string","description":"Request URL. Must resolve to a hostname matching the associated credential's allowlist."},"headers":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Static or dynamic request headers."},"pathParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Path parameter placeholders resolved into the URL."},"queryParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Query string parameters."},"body":{"type":"string","description":"Raw request body template."}}},"config":{"type":"object","properties":{"timeout":{"type":"object","required":["requestSec"],"properties":{"requestSec":{"type":"number"}},"description":"Per-request timeout configuration."},"retry":{"type":"object","required":["maxRetries","retryableStatusCodes"],"properties":{"maxRetries":{"type":"number"},"retryableStatusCodes":{"type":"array","items":{"type":"number"}}},"description":"Retry policy. `retryableStatusCodes` are HTTP codes that should trigger a retry."},"redirects":{"type":"object","required":["maxRedirects"],"properties":{"maxRedirects":{"type":"number"}},"description":"HTTP redirect handling."},"rateLimit":{"type":"object","required":["maxRequestsPerWindow"],"properties":{"maxRequestsPerWindow":{"type":"number"}},"description":"Rate limit applied to outbound requests from this connector."}}},"authId":{"type":["string","null"],"description":"New credential binding. Pass `null` to remove the credential."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["apiConnectorId","name","params","config"],"properties":{"apiConnectorId":{"type":"string","description":"Unique identifier of the API connector."},"name":{"type":"string","description":"Display name of the connector."},"params":{"allOf":[{"type":"object","required":["method","url","headers","pathParams","queryParams","body"],"properties":{"method":{"type":"string","enum":["GET","POST","DELETE","PATCH","PUT","OPTIONS","HEAD"],"description":"HTTP method to invoke."},"url":{"type":"string","description":"Request URL. Must resolve to a hostname matching the associated credential's allowlist."},"headers":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Static or dynamic request headers."},"pathParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Path parameter placeholders resolved into the URL."},"queryParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Query string parameters."},"body":{"type":"string","description":"Raw request body template."}}},{"type":"object","required":["bodyParams"],"properties":{"bodyParams":{"type":"array","items":{"allOf":[{"type":"object","required":["key","mode"],"properties":{"key":{"type":"string"},"mode":{"type":"string","enum":["static","dynamic"]}}},{"type":"object","properties":{"value":{"type":["string","null"]},"type":{"type":["string","null"],"enum":["array","boolean","number","object","raw","string"]},"shape":{"oneOf":[{"$ref":"#/components/schemas/ParamShapeNode"},{"type":"null"}]}}}]},"description":"Dynamic parameters extracted from `body`."}}}]},"config":{"type":"object","required":["timeout","retry","redirects","rateLimit"],"properties":{"timeout":{"type":"object","required":["requestSec"],"properties":{"requestSec":{"type":"number"}},"description":"Per-request timeout configuration."},"retry":{"type":"object","required":["maxRetries","retryableStatusCodes"],"properties":{"maxRetries":{"type":"number"},"retryableStatusCodes":{"type":"array","items":{"type":"number"}}},"description":"Retry policy. `retryableStatusCodes` are HTTP codes that should trigger a retry."},"redirects":{"type":"object","required":["maxRedirects"],"properties":{"maxRedirects":{"type":"number"}},"description":"HTTP redirect handling."},"rateLimit":{"type":"object","required":["maxRequestsPerWindow"],"properties":{"maxRequestsPerWindow":{"type":"number"}},"description":"Rate limit applied to outbound requests from this connector."}}}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description."},"authId":{"type":["string","null"],"description":"Identifier of the API credential (`apiCredentialId`) used to authenticate requests. `null` if unauthenticated."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-connectors"]},"delete":{"summary":"Delete an API connector","description":"This endpoint archives an API connector, preventing it from being used in new workbook actions. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- Retrieve the **apiConnectorId** by calling the [/v2/api-connectors](https://help.sigmacomputing.com/reference/list-api-connectors) endpoint.\n- The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and must have **Can edit** access to the connector.\n\n### Usage scenarios\n- **Cleanup:** Remove connectors that are no longer in use to keep the organization's connector list tidy.\n- **Decommissioning:** Archive connectors associated with deprecated or retired external services.","parameters":[{"name":"apiConnectorId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteApiConnector","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-connectors"]}},"/v2/api-credentials":{"get":{"summary":"List API credentials","description":"This endpoint returns a paginated list of API credentials. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- The user making this request must be assigned an account type with the **Manage API connectors** permission enabled.\n- Only returns [API credentials](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma#add-a-new-api-credential-to-sigma) that the user making this request has at least **Can view** access to.\n- Secret fields such as passwords, tokens, and client secrets are never included in the response.\n- Use the `name` query parameter to filter by credential name.\n- Use the `orderBy` query parameter to set sort order.\n\n### Usage scenarios\n- **Credential management:** View and audit the credentials used by API connectors in your Sigma organization.\n- **API connector creation:** Retrieve available credentials to present as options when creating an API connector.","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"},{"name":"orderBy","schema":{"type":"string","description":"Sort order. Supported fields: `name`, `description`. Append ` desc` for descending (e.g. `name desc`). Defaults to `name` ascending.","title":"Order by"},"in":"query"},{"name":"name","schema":{"type":"string","description":"Filter results to credentials whose name contains this substring."},"in":"query"}],"operationId":"listApiCredentials","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["apiCredentialId","name","authMethod","allowlist"],"properties":{"apiCredentialId":{"type":"string","description":"Unique identifier of the API credential."},"name":{"type":"string","description":"Display name of the credential."},"authMethod":{"type":"string","enum":["basic","bearer","apiKey","oAuthClientCredentials","oAuthAuthorizationCode","oAuthPasswordCredentials","awsSigV4"],"description":"Authentication method the credential uses."},"allowlist":{"type":"array","items":{"type":"string"},"description":"Hostname glob patterns the credential is authorized to be used against."}}},{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description."}}}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-credentials"]},"post":{"summary":"Create an API credential","description":"This endpoint creates a new API credential for use with API connectors and the **Call API** action in Sigma. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- The user making this request must be assigned an account type with the **Manage API connectors** permission enabled.\n- The `allowlist` parameter is required and must contain at least one hostname glob pattern. Use `[\"*\"]` to allow the credential to be used against any host.\n- The following authentication methods are supported: `basic`, `bearer`, `apiKey`, `oAuthClientCredentials`, `oAuthAuthorizationCode`, `oAuthPasswordCredentials`, `awsSigV4`.\n- Secret fields are encrypted at rest and are never returned in subsequent read responses.\n\n### Usage scenarios\n- **Credential provisioning:** Automate credential creation as part of environment setup or onboarding.\n- **Multi-service authentication:** Create separate credentials for each external service, with allowlists scoped to only that service's domains.","parameters":[],"operationId":"createApiCredential","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name","allowlist","credential"],"properties":{"name":{"type":"string","description":"Display name of the credential."},"allowlist":{"type":"array","items":{"type":"string"},"description":"Hostname glob patterns the credential may be used against (e.g. `[\"*.example.com\"]`). Required and must not be empty; use `[\"*\"]` to allow every host."},"credential":{"oneOf":[{"type":"object","required":["authMethod","basic"],"properties":{"authMethod":{"type":"string","enum":["basic"]},"basic":{"type":"object","required":["username","password"],"properties":{"username":{"type":"string","description":"Username for Basic authentication."},"password":{"type":"string","description":"Password for Basic authentication. Encrypted at rest; never returned in responses."}}}},"description":"","title":"Basic"},{"type":"object","required":["authMethod","bearer"],"properties":{"authMethod":{"type":"string","enum":["bearer"]},"bearer":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"Bearer token. Encrypted at rest; never returned in responses."}}}},"description":"","title":"Bearer"},{"type":"object","required":["authMethod","apiKey"],"properties":{"authMethod":{"type":"string","enum":["apiKey"]},"apiKey":{"type":"object","required":["key","value","isQueryParam"],"properties":{"key":{"type":"string","description":"Header or query parameter name carrying the API key."},"value":{"type":"string","description":"API key value. Encrypted at rest; never returned in responses."},"isQueryParam":{"type":"boolean","description":"Whether the key is sent as a query parameter; if false, it is sent as a header."}}}},"description":"","title":"API key"},{"type":"object","required":["authMethod","oAuthClientCredentials"],"properties":{"authMethod":{"type":"string","enum":["oAuthClientCredentials"]},"oAuthClientCredentials":{"type":"object","required":["clientId","clientSecret","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"clientId":{"type":"string","description":"OAuth client ID."},"clientSecret":{"type":"string","description":"OAuth client secret. Encrypted at rest; never returned in responses."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes requested at token exchange."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}}},"description":"","title":"OAuth client credentials"},{"type":"object","required":["authMethod","awsSigV4"],"properties":{"authMethod":{"type":"string","enum":["awsSigV4"]},"awsSigV4":{"allOf":[{"type":"object","required":["accessKeyId","secretAccessKey"],"properties":{"accessKeyId":{"type":"string","description":"AWS access key ID."},"secretAccessKey":{"type":"string","description":"AWS secret access key. Encrypted at rest; never returned in responses."}}},{"type":"object","properties":{"region":{"type":"string","description":"AWS region for SigV4 signing."},"service":{"type":"string","description":"AWS service name for SigV4 signing (e.g. `s3`, `execute-api`)."},"sessionToken":{"type":"string","description":"AWS STS session token for temporary credentials."},"temporaryCredentialsUrl":{"type":"string","description":"URL that vends temporary credentials (e.g. STS AssumeRole endpoint)."},"temporaryCredentialsResponseMapping":{"type":"object","properties":{"accessKeyField":{"type":"string"},"secretKeyField":{"type":"string"},"sessionTokenField":{"type":"string"},"expirationField":{"type":"string"}}},"temporaryCredentialsRequestParams":{"type":"array","items":{"type":"object","required":["key","value","sendIn"],"properties":{"key":{"type":"string"},"value":{"type":"string"},"sendIn":{"type":"string","enum":["queryParam","body","header"]}}},"description":"Additional key/value parameters attached to the temporary-credentials swap request. Each entry specifies whether it is sent as a request header, body field, or query parameter (`sendIn`: `header` | `body` | `queryParam`). Use this when the swap endpoint requires its own authentication (for example, an `x-api-key` header)."}}}]}},"description":"","title":"AWS SigV4"}]}}},{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["apiCredentialId","name","authMethod","allowlist","credential"],"properties":{"apiCredentialId":{"type":"string","description":"Unique identifier of the API credential."},"name":{"type":"string","description":"Display name of the credential."},"authMethod":{"type":"string","enum":["basic","bearer","apiKey","oAuthClientCredentials","oAuthAuthorizationCode","oAuthPasswordCredentials","awsSigV4"],"description":"Authentication method the credential uses."},"allowlist":{"type":"array","items":{"type":"string"},"description":"Hostname glob patterns (e.g. `*.example.com`) that the credential is authorized to be used against."},"credential":{"oneOf":[{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["basic"]}}},{"type":"object","properties":{"basic":{"type":"object","required":["username"],"properties":{"username":{"type":"string","description":"Username for Basic authentication."}}}}}],"description":"","title":"Basic"},{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["bearer"]}},"description":"","title":"Bearer"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["apiKey"]}}},{"type":"object","properties":{"apiKey":{"type":"object","required":["key","isQueryParam"],"properties":{"key":{"type":"string","description":"Header or query parameter name carrying the API key."},"isQueryParam":{"type":"boolean","description":"Whether the key is sent as a query parameter; if false, it is sent as a header."}}}}}],"description":"","title":"API key"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["oAuthClientCredentials"]}}},{"type":"object","properties":{"oAuthClientCredentials":{"type":"object","required":["clientId","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"clientId":{"type":"string","description":"OAuth client ID."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes requested at token exchange."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}}}}],"description":"","title":"OAuth client credentials"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["oAuthAuthorizationCode"]}}},{"type":"object","properties":{"oAuthAuthorizationCode":{"type":"object","required":["clientId","authorizationUrl","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"clientId":{"type":"string","description":"OAuth client ID."},"authorizationUrl":{"type":"string","description":"OAuth authorization endpoint URL."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}}}}],"description":"","title":"OAuth authorization code"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["oAuthPasswordCredentials"]}}},{"type":"object","properties":{"oAuthPasswordCredentials":{"allOf":[{"type":"object","required":["username","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"username":{"type":"string","description":"OAuth resource-owner username."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}},{"type":"object","properties":{"clientId":{"type":"string","description":"OAuth client ID."}}}]}}}],"description":"","title":"OAuth password credentials"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["awsSigV4"]}}},{"type":"object","properties":{"awsSigV4":{"allOf":[{"type":"object","required":["accessKeyId"],"properties":{"accessKeyId":{"type":"string","description":"AWS access key ID."}}},{"type":"object","properties":{"region":{"type":"string","description":"AWS region for SigV4 signing."},"service":{"type":"string","description":"AWS service name for SigV4 signing (e.g. `s3`, `execute-api`)."},"temporaryCredentialsUrl":{"type":"string","description":"URL that vends temporary credentials (e.g. STS AssumeRole endpoint)."},"temporaryCredentialsResponseMapping":{"type":"object","properties":{"accessKeyField":{"type":"string"},"secretKeyField":{"type":"string"},"sessionTokenField":{"type":"string"},"expirationField":{"type":"string"}}},"temporaryCredentialsRequestParams":{"type":"array","items":{"type":"object","required":["key","value","sendIn"],"properties":{"key":{"type":"string"},"value":{"type":"string"},"sendIn":{"type":"string","enum":["queryParam","body","header"]}}},"description":"Additional parameters sent on the temporary-credentials swap request, each tagged with `sendIn` (`header` | `body` | `queryParam`)."}}}]}}}],"description":"","title":"AWS SigV4"}],"description":"Nonsensitive projection of the credential, discriminated by `authMethod`. Secret fields (password, token, clientSecret, secretAccessKey) are never returned."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-credentials"]}},"/v2/api-credentials/{apiCredentialId}":{"get":{"summary":"Get an API credential","description":"This endpoint returns nonsensitive details for a single API credential. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and have at least **Can view** access on the credential.\n- Retrieve the **apiCredentialId** by calling the [/v2/api-credentials](https://help.sigmacomputing.com/reference/list-api-credentials) endpoint.\n- Secret fields (passwords, tokens, client secrets, secret access keys) are never returned.\n\n### Usage scenarios\n- **Credential inspection:** Retrieve the configuration of a credential to verify its settings before using it with a connector.","parameters":[{"name":"apiCredentialId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getApiCredential","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["apiCredentialId","name","authMethod","allowlist","credential"],"properties":{"apiCredentialId":{"type":"string","description":"Unique identifier of the API credential."},"name":{"type":"string","description":"Display name of the credential."},"authMethod":{"type":"string","enum":["basic","bearer","apiKey","oAuthClientCredentials","oAuthAuthorizationCode","oAuthPasswordCredentials","awsSigV4"],"description":"Authentication method the credential uses."},"allowlist":{"type":"array","items":{"type":"string"},"description":"Hostname glob patterns (e.g. `*.example.com`) that the credential is authorized to be used against."},"credential":{"oneOf":[{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["basic"]}}},{"type":"object","properties":{"basic":{"type":"object","required":["username"],"properties":{"username":{"type":"string","description":"Username for Basic authentication."}}}}}],"description":"","title":"Basic"},{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["bearer"]}},"description":"","title":"Bearer"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["apiKey"]}}},{"type":"object","properties":{"apiKey":{"type":"object","required":["key","isQueryParam"],"properties":{"key":{"type":"string","description":"Header or query parameter name carrying the API key."},"isQueryParam":{"type":"boolean","description":"Whether the key is sent as a query parameter; if false, it is sent as a header."}}}}}],"description":"","title":"API key"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["oAuthClientCredentials"]}}},{"type":"object","properties":{"oAuthClientCredentials":{"type":"object","required":["clientId","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"clientId":{"type":"string","description":"OAuth client ID."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes requested at token exchange."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}}}}],"description":"","title":"OAuth client credentials"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["oAuthAuthorizationCode"]}}},{"type":"object","properties":{"oAuthAuthorizationCode":{"type":"object","required":["clientId","authorizationUrl","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"clientId":{"type":"string","description":"OAuth client ID."},"authorizationUrl":{"type":"string","description":"OAuth authorization endpoint URL."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}}}}],"description":"","title":"OAuth authorization code"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["oAuthPasswordCredentials"]}}},{"type":"object","properties":{"oAuthPasswordCredentials":{"allOf":[{"type":"object","required":["username","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"username":{"type":"string","description":"OAuth resource-owner username."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}},{"type":"object","properties":{"clientId":{"type":"string","description":"OAuth client ID."}}}]}}}],"description":"","title":"OAuth password credentials"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["awsSigV4"]}}},{"type":"object","properties":{"awsSigV4":{"allOf":[{"type":"object","required":["accessKeyId"],"properties":{"accessKeyId":{"type":"string","description":"AWS access key ID."}}},{"type":"object","properties":{"region":{"type":"string","description":"AWS region for SigV4 signing."},"service":{"type":"string","description":"AWS service name for SigV4 signing (e.g. `s3`, `execute-api`)."},"temporaryCredentialsUrl":{"type":"string","description":"URL that vends temporary credentials (e.g. STS AssumeRole endpoint)."},"temporaryCredentialsResponseMapping":{"type":"object","properties":{"accessKeyField":{"type":"string"},"secretKeyField":{"type":"string"},"sessionTokenField":{"type":"string"},"expirationField":{"type":"string"}}},"temporaryCredentialsRequestParams":{"type":"array","items":{"type":"object","required":["key","value","sendIn"],"properties":{"key":{"type":"string"},"value":{"type":"string"},"sendIn":{"type":"string","enum":["queryParam","body","header"]}}},"description":"Additional parameters sent on the temporary-credentials swap request, each tagged with `sendIn` (`header` | `body` | `queryParam`)."}}}]}}}],"description":"","title":"AWS SigV4"}],"description":"Nonsensitive projection of the credential, discriminated by `authMethod`. Secret fields (password, token, clientSecret, secretAccessKey) are never returned."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-credentials"]},"patch":{"summary":"Update an API credential","description":"This endpoint updates one or more fields on an existing API credential. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and have **Can edit** access to the API credential.\n- Retrieve the **apiCredentialId** by calling the [/v2/api-credentials](https://help.sigmacomputing.com/reference/list-api-credentials) endpoint.\n- Omitted fields are left unchanged.\n- If a `credential` is provided, the provided authentication details (ID, secret, etc.) replace the previous values. To leave secrets unchanged, omit the `credential` parameter.\n\n### Usage scenarios\n- **Secret rotation:** Update the secret fields for a credential automatically for an external service.\n- **Allowlist updates:** Expand or restrict the set of hostnames the credential can be used against.","parameters":[{"name":"apiCredentialId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateApiCredential","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New display name."},"description":{"type":["string","null"],"description":"New description. Pass `null` to clear."},"allowlist":{"type":"array","items":{"type":"string"},"description":"Replacement list of hostname glob patterns. Must not be empty; use `[\"*\"]` to allow every host."},"credential":{"oneOf":[{"type":"object","required":["authMethod","basic"],"properties":{"authMethod":{"type":"string","enum":["basic"]},"basic":{"type":"object","required":["username","password"],"properties":{"username":{"type":"string","description":"Username for Basic authentication."},"password":{"type":"string","description":"Password for Basic authentication. Encrypted at rest; never returned in responses."}}}},"description":"","title":"Basic"},{"type":"object","required":["authMethod","bearer"],"properties":{"authMethod":{"type":"string","enum":["bearer"]},"bearer":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"Bearer token. Encrypted at rest; never returned in responses."}}}},"description":"","title":"Bearer"},{"type":"object","required":["authMethod","apiKey"],"properties":{"authMethod":{"type":"string","enum":["apiKey"]},"apiKey":{"type":"object","required":["key","value","isQueryParam"],"properties":{"key":{"type":"string","description":"Header or query parameter name carrying the API key."},"value":{"type":"string","description":"API key value. Encrypted at rest; never returned in responses."},"isQueryParam":{"type":"boolean","description":"Whether the key is sent as a query parameter; if false, it is sent as a header."}}}},"description":"","title":"API key"},{"type":"object","required":["authMethod","oAuthClientCredentials"],"properties":{"authMethod":{"type":"string","enum":["oAuthClientCredentials"]},"oAuthClientCredentials":{"type":"object","required":["clientId","clientSecret","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"clientId":{"type":"string","description":"OAuth client ID."},"clientSecret":{"type":"string","description":"OAuth client secret. Encrypted at rest; never returned in responses."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes requested at token exchange."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}}},"description":"","title":"OAuth client credentials"},{"type":"object","required":["authMethod","awsSigV4"],"properties":{"authMethod":{"type":"string","enum":["awsSigV4"]},"awsSigV4":{"allOf":[{"type":"object","required":["accessKeyId","secretAccessKey"],"properties":{"accessKeyId":{"type":"string","description":"AWS access key ID."},"secretAccessKey":{"type":"string","description":"AWS secret access key. Encrypted at rest; never returned in responses."}}},{"type":"object","properties":{"region":{"type":"string","description":"AWS region for SigV4 signing."},"service":{"type":"string","description":"AWS service name for SigV4 signing (e.g. `s3`, `execute-api`)."},"sessionToken":{"type":"string","description":"AWS STS session token for temporary credentials."},"temporaryCredentialsUrl":{"type":"string","description":"URL that vends temporary credentials (e.g. STS AssumeRole endpoint)."},"temporaryCredentialsResponseMapping":{"type":"object","properties":{"accessKeyField":{"type":"string"},"secretKeyField":{"type":"string"},"sessionTokenField":{"type":"string"},"expirationField":{"type":"string"}}},"temporaryCredentialsRequestParams":{"type":"array","items":{"type":"object","required":["key","value","sendIn"],"properties":{"key":{"type":"string"},"value":{"type":"string"},"sendIn":{"type":"string","enum":["queryParam","body","header"]}}},"description":"Additional key/value parameters attached to the temporary-credentials swap request. Each entry specifies whether it is sent as a request header, body field, or query parameter (`sendIn`: `header` | `body` | `queryParam`). Use this when the swap endpoint requires its own authentication (for example, an `x-api-key` header)."}}}]}},"description":"","title":"AWS SigV4"}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["apiCredentialId","name","authMethod","allowlist","credential"],"properties":{"apiCredentialId":{"type":"string","description":"Unique identifier of the API credential."},"name":{"type":"string","description":"Display name of the credential."},"authMethod":{"type":"string","enum":["basic","bearer","apiKey","oAuthClientCredentials","oAuthAuthorizationCode","oAuthPasswordCredentials","awsSigV4"],"description":"Authentication method the credential uses."},"allowlist":{"type":"array","items":{"type":"string"},"description":"Hostname glob patterns (e.g. `*.example.com`) that the credential is authorized to be used against."},"credential":{"oneOf":[{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["basic"]}}},{"type":"object","properties":{"basic":{"type":"object","required":["username"],"properties":{"username":{"type":"string","description":"Username for Basic authentication."}}}}}],"description":"","title":"Basic"},{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["bearer"]}},"description":"","title":"Bearer"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["apiKey"]}}},{"type":"object","properties":{"apiKey":{"type":"object","required":["key","isQueryParam"],"properties":{"key":{"type":"string","description":"Header or query parameter name carrying the API key."},"isQueryParam":{"type":"boolean","description":"Whether the key is sent as a query parameter; if false, it is sent as a header."}}}}}],"description":"","title":"API key"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["oAuthClientCredentials"]}}},{"type":"object","properties":{"oAuthClientCredentials":{"type":"object","required":["clientId","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"clientId":{"type":"string","description":"OAuth client ID."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes requested at token exchange."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}}}}],"description":"","title":"OAuth client credentials"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["oAuthAuthorizationCode"]}}},{"type":"object","properties":{"oAuthAuthorizationCode":{"type":"object","required":["clientId","authorizationUrl","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"clientId":{"type":"string","description":"OAuth client ID."},"authorizationUrl":{"type":"string","description":"OAuth authorization endpoint URL."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}}}}],"description":"","title":"OAuth authorization code"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["oAuthPasswordCredentials"]}}},{"type":"object","properties":{"oAuthPasswordCredentials":{"allOf":[{"type":"object","required":["username","accessTokenUrl","scopes","accessTokenAuthMethod"],"properties":{"username":{"type":"string","description":"OAuth resource-owner username."},"accessTokenUrl":{"type":"string","description":"OAuth token endpoint URL."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes."},"accessTokenAuthMethod":{"type":"string","enum":["httpBasic","requestBody"],"description":"How client credentials are presented to the token endpoint."}}},{"type":"object","properties":{"clientId":{"type":"string","description":"OAuth client ID."}}}]}}}],"description":"","title":"OAuth password credentials"},{"allOf":[{"type":"object","required":["authMethod"],"properties":{"authMethod":{"type":"string","enum":["awsSigV4"]}}},{"type":"object","properties":{"awsSigV4":{"allOf":[{"type":"object","required":["accessKeyId"],"properties":{"accessKeyId":{"type":"string","description":"AWS access key ID."}}},{"type":"object","properties":{"region":{"type":"string","description":"AWS region for SigV4 signing."},"service":{"type":"string","description":"AWS service name for SigV4 signing (e.g. `s3`, `execute-api`)."},"temporaryCredentialsUrl":{"type":"string","description":"URL that vends temporary credentials (e.g. STS AssumeRole endpoint)."},"temporaryCredentialsResponseMapping":{"type":"object","properties":{"accessKeyField":{"type":"string"},"secretKeyField":{"type":"string"},"sessionTokenField":{"type":"string"},"expirationField":{"type":"string"}}},"temporaryCredentialsRequestParams":{"type":"array","items":{"type":"object","required":["key","value","sendIn"],"properties":{"key":{"type":"string"},"value":{"type":"string"},"sendIn":{"type":"string","enum":["queryParam","body","header"]}}},"description":"Additional parameters sent on the temporary-credentials swap request, each tagged with `sendIn` (`header` | `body` | `queryParam`)."}}}]}}}],"description":"","title":"AWS SigV4"}],"description":"Nonsensitive projection of the credential, discriminated by `authMethod`. Secret fields (password, token, clientSecret, secretAccessKey) are never returned."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"Human-readable description."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-credentials"]},"delete":{"summary":"Delete an API credential","description":"This endpoint archives an API credential so it can no longer be associated with new API connectors. For more information on API credentials, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma).\n\n### Usage notes\n- The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and have **Can edit** access to the API credential.\n- Retrieve the **apiCredentialId** by calling the [/v2/api-credentials](https://help.sigmacomputing.com/reference/list-api-credentials) endpoint.\n- Archiving a credential does not automatically unbind any API connectors that reference it.\n\n### Usage scenarios\n- **Credential decommissioning:** Remove credentials for decommissioned services or expired tokens.\n- **Security cleanup:** Archive compromised or rotated credentials to prevent accidental reuse.","parameters":[{"name":"apiCredentialId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteApiCredential","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["api-credentials"]}},"/v2/auth/token":{"post":{"summary":"Get access token","description":"Use your Sigma client ID and secret with this endpoint to generate an access token valid for one hour, or to refresh your token. You can then use the access token to authenticate requests made to the Sigma API.\n\nTo make any API call with the Sigma API, including calls from the API documentation, you must have a valid bearer token. To generate a token, you must have a valid **Client ID** and **Secret**. See [Generate Sigma API client credentials](generate-client-credentials).\n\nYou make all API calls to a specific URL that corresponds to the cloud where your Sigma environment is hosted. Set the **Base URL** to the relevant URL for your environment. For details, see [Identify your API request URL](get-started-sigma-api#identify-your-api-request-url).\n\nGenerate a token by sending a POST request to this `/v2/auth/token` endpoint, or use the **Try It!** option on this page.\n\n### Usage notes\n\n- The API token is valid for 1 hour. When the token expires, an endpoint response returns an unauthorized error.\n- Refresh your access token before it expires using the `refresh_token` option.\n- If your client credentials are owned by a user assigned the Admin account type, you can generate an access token as a specific user using impersonation.\n  ","parameters":[],"operationId":"postToken","requestBody":{"description":"The request body.","content":{"application/x-www-form-urlencoded":{"schema":{"oneOf":[{"allOf":[{"type":"object","required":["grant_type"],"properties":{"grant_type":{"type":"string","enum":["client_credentials"],"description":"Set to `client_credentials` to retrieve an access token."}}},{"type":"object","properties":{}}],"description":"","title":"Access token"},{"type":"object","required":["grant_type","refresh_token"],"properties":{"grant_type":{"type":"string","enum":["refresh_token"],"description":"Set to `refresh_token` to refresh your access token. "},"refresh_token":{"type":"string"}},"description":"","title":"Refresh token"},{"allOf":[{"type":"object","required":["grant_type","subject_token","subject_token_type","actor_token","actor_token_type"],"properties":{"grant_type":{"type":"string","enum":["urn:ietf:params:oauth:grant-type:token-exchange"],"description":"Set to `urn:ietf:params:oauth:grant-type:token-exchange` to get an impersonated token."},"subject_token":{"type":"string","description":"A self-signed JWT token with the following claims: `kid` (the client ID), and either `sub` (the email of the user to impersonate), `tenant` (the organization ID of the tenant to impersonate), or both. When `tenant` is provided without `sub`, the tenant admin user will be impersonated. When both are provided, the specified user will be impersonated within the context of that tenant organization.","title":"Subject token"},"subject_token_type":{"type":"string","enum":["urn:ietf:params:oauth:token-type:jwt"]},"actor_token":{"type":"string","description":"An access token owned by a Sigma user assigned the Admin account type. This token must match the bearer token in the request authorization header.","title":"Actor token"},"actor_token_type":{"type":"string","enum":["urn:ietf:params:oauth:token-type:access_token"]}}},{"type":"object","properties":{}}],"description":"(Beta) Generate an access token as a specific user using a JSON Web Token (JWT).","title":"(Beta) Impersonation"}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"type":"object","required":["access_token","refresh_token","token_type","expires_in"],"properties":{"access_token":{"type":"string","description":"Token used to access the API and make requests."},"refresh_token":{"type":"string","description":"Refresh token used to refresh access token."},"token_type":{"type":"string","enum":["bearer"]},"expires_in":{"type":"number","description":"Number of seconds in which the token expires."}}},{"type":"object","properties":{}}],"description":"","title":"Access / Refresh token"},{"allOf":[{"type":"object","required":["access_token","issued_token_type","token_type","expires_in"],"properties":{"access_token":{"type":"string","description":"Access token used to access the API and make requests as the impersonated user."},"issued_token_type":{"type":"string","enum":["urn:ietf:params:oauth:token-type:access_token"]},"token_type":{"type":"string","enum":["Bearer"]},"expires_in":{"type":"number","description":"Number of seconds in which the token expires."}}},{"type":"object","properties":{}}],"description":"","title":"(Beta) Impersonation"}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["auth"],"security":[{"basicAuth":[]},{"bearerAuth":[]}]}},"/v2/connection/{connectionId}/lookup":{"post":{"summary":"Look up connections by path","description":"This endpoint returns details about the fully qualified path to an object in a specific connection by connection ID.\n\n  ### Usage notes\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n\n  Different connections support different paths:\n\n  - For a Snowflake connection, you can specify `DATABASE.SCHEMA.TABLE`, `DATABASE.SCHEMA.STORED_PROCEDURE`, or a less-specific path.\n  - For Amazon Redshift, you can specify `SCHEMA.TABLE`, `SCHEMA.STORED_PROCEDURE`, or a less-specific path.\n  - For Databricks, you can specify `CATALOG.SCHEMA.TABLE` or a less-specific path.\n\n  Connection path details include the connection path ID, called the `inodeId` in the response, and the type of object in the connection path, either a table or a scope (database, schema, catalog, or other higher-level object).","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"lookupConnection","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["path"],"properties":{"path":{"oneOf":[{"type":"array","minItems":3,"maxItems":3,"items":{"type":"string","description":"Database name","title":"Database"},"description":"Represents a path of the form `DATABASE.SCHEMA.TABLE` or `DATABASE.SCHEMA.STORED_PROCEDURE`.","title":"Table or Object Path"},{"type":"array","minItems":2,"maxItems":2,"items":{"type":"string","description":"Database Name","title":"Database"},"description":"Represents a path of the form `DATABASE.SCHEMA`.","title":"Schema Path"},{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","description":"Database Name","title":"Database"},"description":"Represents a path of the form `DATABASE`.","title":"Database Path"},{"type":"array","items":{},"maxItems":0,"description":"Empty path to sync the entire connection.","title":"Empty Path"}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["kind","inodeId","url"],"properties":{"kind":{"type":"string","enum":["scope","table","semanticView","metricView","stored-procedure"]},"inodeId":{"type":"string"},"url":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections":{"get":{"summary":"List connections","description":"Get a list of available connections and the connection IDs.","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"includeArchived","schema":{"type":"boolean"},"in":"query"},{"name":"search","schema":{"type":"string","description":"Search filter for the name of the connection."},"in":"query"}],"operationId":"listConnections","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["organizationId","connectionId","isSample","isAuditLog","lastActiveAt","name","type","useOauth","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"organizationId":{"type":"string","description":"Unique identifier of the organization"},"connectionId":{"type":"string","description":"Unique identifier of the connection"},"isSample":{"type":"boolean","description":"Whether the connection is the Sigma sample data connection"},"isAuditLog":{"type":"boolean","description":"Whether audit logging is enabled"},"lastActiveAt":{"type":"string","format":"date-time","description":"Last activity date and time"},"name":{"type":"string","description":"Name of the connection"},"type":{"type":"string","description":"Type of the connection (e.g., \"bigQuery\")"},"useOauth":{"type":"boolean","description":"Whether OAuth is used"},"createdBy":{"type":"string","description":"Identifier of the user who created this connection"},"updatedBy":{"type":"string","description":"Identifier of the user or process that last updated this connection"},"createdAt":{"type":"string","format":"date-time","description":"When the connection was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the connection was last updated"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether the connection is archived"},"account":{"type":"string","description":"Account associated with the connection"},"warehouse":{"type":"string","description":"Warehouse associated with the connection"},"user":{"type":"string","description":"User associated with the connection"},"httpPath":{"type":"string","description":"For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path."},"role":{"type":"string","description":"Role used by the connection user"},"timeout":{"allOf":[{"type":"object","required":["default"],"properties":{"default":{"type":"number"}}},{"type":"object","properties":{"worksheet":{"type":"number"},"dashboard":{"type":"number"},"download":{"type":"number"}}}],"description":"Timeout settings for the connection, with a default value in seconds"},"poolSizes":{"type":"object","properties":{"isPoolConfigured":{"type":"boolean"},"adhocPoolSize":{"type":"number"},"catalogPoolSize":{"type":"number"},"resultPoolSize":{"type":"number"},"schedulePoolSize":{"type":"number"}},"description":"Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize"},"writeAccess":{"type":"boolean"},"friendlyName":{"type":"boolean","description":"Whether friendly names are enabled for this connection"},"writebacks":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for non-OAuth connections"},"writebackSchemas":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for OAuth connections"},"inputTableAuditLogSchema":{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}],"description":"Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection."},"materializationWarehouse":{"type":"string","description":"Warehouse used to run materialization jobs"},"exportsWarehouse":{"type":"string","description":"Warehouse used to run export jobs"},"oauthMetadataUrl":{"type":"string","description":"OAuth metadata URL configured directly on this connection."},"oauthClientId":{"type":"string","description":"Client ID configured directly on this connection."},"oauthScopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes configured directly on this connection."},"oauthIdpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"description":"OAuth provider type configured or inferred for this connection."},"oauthUsePkce":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses PKCE."},"oauthUseJwt":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses JWT bearer token authentication."},"oauthAudience":{"type":"string","description":"Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery."},"isIndependentOAuth":{"type":"boolean","description":"Whether this connection uses connection-level OAuth instead of organization-level OAuth."},"userAttributes":{"type":"object","properties":{"role":{"type":"string"},"warehouse":{"type":"string"}},"description":"User attributes associated with the connection"},"roleSwitching":{"type":"string","enum":["allRoles","disabled"],"description":"Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant for Snowflake OAuth connections."},"enableHiveMetastore":{"type":"boolean","description":"Whether this Databricks connection exposes the `hive_metastore` catalog in Sigma. Only relevant for Databricks connections.","title":"Enable Hive metastore"},"usePython":{"type":"boolean","title":"Enable Python queries"},"pythonComputeClusterId":{"type":"string","description":"ID of the all-purpose compute cluster used to run Python queries. Only relevant for Databricks connections with Python enabled.","title":"Compute cluster ID"}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]},"examples":{"Organization":{"value":{"entries":[{"organizationId":"2f6b8e4a-9c1d-4b7a-8e2c-6d3f9a1b5c7e","connectionId":"9f2a6b1e-4c3d-4a8f-9e21-6d7c8b3a51f0","name":"Snowflake Example","type":"snowflake","isSample":false,"isAuditLog":false,"useOauth":false,"isArchived":false,"friendlyName":true,"isIndependentOAuth":false,"lastActiveAt":"2026-08-20T16:42:00.000Z","createdBy":"qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h","updatedBy":"qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h","createdAt":"2024-02-11T18:05:00.000Z","updatedAt":"2026-08-20T16:42:00.000Z"}],"hasMore":false,"total":1,"nextPage":null}},"Impersonating Acme West tenant":{"value":{"entries":[{"organizationId":"5e9c2b7a-3f1d-4a8e-9b6c-2d4f8a1e6c3b","connectionId":"3d4e8f21-7b6c-4a9d-8e12-5f6a7b8c9d0e","name":"Snowflake - Tenant Example","type":"snowflake","isSample":false,"isAuditLog":false,"useOauth":false,"isArchived":false,"friendlyName":true,"isIndependentOAuth":false,"lastActiveAt":"2026-08-19T09:12:00.000Z","createdBy":"qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h","updatedBy":"qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h","createdAt":"2025-06-03T14:20:00.000Z","updatedAt":"2026-08-19T09:12:00.000Z"}],"hasMore":false,"total":1,"nextPage":null}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]},"post":{"summary":"Create a connection","description":"Create a connection to a cloud data warehouse from Sigma. For additional details, see [Connect to data sources](https://help.sigmacomputing.com/docs/connect-to-data-sources).","parameters":[],"operationId":"createConnection","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["details","name"],"properties":{"details":{"oneOf":[{"allOf":[{"type":"object","required":["type","host","database"],"properties":{"type":{"type":"string","enum":["postgres","redshift","alloydb"]},"host":{"type":"string"},"database":{"type":"string"}}},{"type":"object","properties":{"user":{"type":"string"},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]},"port":{"type":"number"},"useTls":{"type":"boolean"},"writeAccess":{"type":"object","required":["writeSchema"],"properties":{"writeSchema":{"type":"string"}}}}}],"description":"Details of the PostgreSQL connection.","title":"PostgreSQL"},{"allOf":[{"allOf":[{"type":"object","required":["type","projectId"],"properties":{"type":{"type":"string","enum":["bigQuery"]},"projectId":{"type":"string"}}},{"type":"object","properties":{"additionalProjectIds":{"type":"array","items":{"type":"string"}},"serviceAccount":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}}}]},{"type":"object","properties":{"metadataUrl":{"type":"string","description":"OAuth metadata URL for connection-level OAuth."},"clientId":{"type":"string","description":"Client ID for the OAuth application used by this connection."},"clientSecret":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes to request when users authenticate to this connection."},"idpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"type":"null","description":"OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown."},"usePkce":{"type":["boolean","null"],"description":"Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE."},"useJwt":{"type":["boolean","null"],"description":"Whether the OAuth flow should use JWT bearer token authentication instead of a client secret."}}},{"type":"object","properties":{"useOauth":{"type":"boolean","description":"Whether this BigQuery connection uses OAuth federation."},"audience":{"type":"string","description":"Google workforce identity federation audience used to exchange the OAuth token for a Google access token."},"writeAccess":{"type":"object","required":["writeProject","writeDataset"],"properties":{"writeProject":{"type":"string"},"writeDataset":{"type":"string"}}}}}],"description":"Details of the BigQuery connection.","title":"Google BigQuery"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["snowflake"]}}},{"type":"object","properties":{"server":{"type":"string"},"account":{"type":"string"},"host":{"type":"string"},"warehouse":{"type":"string"},"role":{"type":"string"},"authType":{"type":"string","enum":["basic-auth","key-pair","oauth"]}}},{"oneOf":[{"type":"object","required":["user","password"],"properties":{"user":{"type":"string"},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}},"description":"Set up basic authentication for the connection","title":"Basic Authentication"},{"allOf":[{"type":"object","required":["user","privateKey"],"properties":{"user":{"type":"string"},"privateKey":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}}},{"type":"object","properties":{"privateKeyPassphrase":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}}}],"description":"Set up key-pair authentication for the connection","title":"Key-Pair Authentication"},{"type":"object","required":["useOauth"],"properties":{"useOauth":{"type":"boolean","enum":[true]}},"description":"Set up OAuth for the connection","title":"OAuth"}]},{"type":"object","properties":{"usePython":{"type":"boolean"},"pythonSecrets":{"type":"object","properties":{"setupUser":{"allOf":[{"type":"object","required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}}},{"type":"object","properties":{"role":{"type":"string"}}}]},"pythonUser":{"allOf":[{"type":"object","required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}}},{"type":"object","properties":{"role":{"type":"string"}}}]}}},"pythonProperties":{"type":"object","properties":{"serviceNames":{"type":"array","items":{"type":"string"}},"externalAccessIntegration":{"type":"string"}}}}},{"type":"object","properties":{"useSourceSwapPolicy":{"type":"boolean"},"sourceSwapPolicyId":{"type":"string"}}}]},{"type":"object","properties":{"metadataUrl":{"type":"string","description":"OAuth metadata URL for connection-level OAuth."},"clientId":{"type":"string","description":"Client ID for the OAuth application used by this connection."},"clientSecret":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes to request when users authenticate to this connection."},"idpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"type":"null","description":"OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown."},"usePkce":{"type":["boolean","null"],"description":"Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE."},"useJwt":{"type":["boolean","null"],"description":"Whether the OAuth flow should use JWT bearer token authentication instead of a client secret."}}},{"type":"object","properties":{"exportsWarehouse":{"type":"string","description":"Warehouse to use for export workloads."},"writeAccess":{"oneOf":[{"allOf":[{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"materializationWarehouse":{"type":"string","description":"Warehouse to use for materialization workloads"},"useDynamicTables":{"type":"boolean","description":"Whether to use Snowflake dynamic tables for materialization workloads."}}}],"description":"","title":"Set write location and materialization warehouse"},{"type":"object","properties":{"materializationWarehouse":{"type":"string","description":"Warehouse to use for materialization workloads"},"useDynamicTables":{"type":"boolean","description":"Whether to use Snowflake dynamic tables for materialization workloads."}},"description":"","title":"Set materialization warehouse"}],"description":"Specify write access for non-OAuth connections"},"userAttributes":{"type":"object","properties":{"role":{"type":"string"},"warehouse":{"type":"string"}}},"writebackSchemas":{"type":"array","items":{"allOf":[{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the write-back destination"},"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for OAuth connections"},"inputTableAuditLogSchema":{"allOf":[{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}],"description":"Specify a schema for input table write access logs"},"pythonProperties":{"type":"object","properties":{"externalAccessIntegration":{"type":"string","description":"Name of the Snowflake external access integration to enable for Python."},"warehouse":{"type":"string","description":"Warehouse to use to run Python code."},"packages":{"type":"string","description":"Comma-separated list of Python packages to install."}},"description":"Python configuration for this Snowflake connection."},"roleSwitching":{"type":"string","enum":["allRoles","disabled"],"description":"Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant when `useOauth` is true."}}}],"description":"Details of the Snowflake connection.","title":"Snowflake"},{"allOf":[{"allOf":[{"type":"object","required":["type","host"],"properties":{"type":{"type":"string","enum":["databricks"]},"host":{"type":"string"}}},{"oneOf":[{"type":"object","required":["endpoint"],"properties":{"endpoint":{"type":"string"}}},{"type":"object","required":["userAttributes"],"properties":{"userAttributes":{"type":"object","required":["endpoint"],"properties":{"endpoint":{"type":"string"}}}}}]},{"oneOf":[{"type":"object","required":["token"],"properties":{"token":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}},"description":"Set up basic authentication for the connection","title":"Basic Authentication"},{"type":"object","required":["useOauth"],"properties":{"useOauth":{"type":"boolean","enum":[true]}},"description":"Set up OAuth for the connection","title":"OAuth"}]},{"type":"object","properties":{"workspaceUrl":{"type":"string"},"useSourceSwapPolicy":{"type":"boolean"},"sourceSwapPolicyId":{"type":"string"},"usePython":{"type":"boolean","description":"Set to `true` to enable Python queries on this Databricks connection. Requires `pythonComputeClusterId`.","title":"Use Python"}}}]},{"type":"object","properties":{"metadataUrl":{"type":"string","description":"OAuth metadata URL for connection-level OAuth."},"clientId":{"type":"string","description":"Client ID for the OAuth application used by this connection."},"clientSecret":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes to request when users authenticate to this connection."},"idpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"type":"null","description":"OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown."},"usePkce":{"type":["boolean","null"],"description":"Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE."},"useJwt":{"type":["boolean","null"],"description":"Whether the OAuth flow should use JWT bearer token authentication instead of a client secret."}}},{"type":"object","properties":{"writeAccess":{"type":"object","required":["writeCatalog","writeSchema"],"properties":{"writeCatalog":{"type":"string","description":"Catalog or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}},"description":"Configure write-back for non-OAuth connections"},"writebackSchemas":{"type":"array","items":{"allOf":[{"type":"object","required":["writeCatalog","writeSchema"],"properties":{"writeCatalog":{"type":"string","description":"Catalog or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the write-back destination"},"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for OAuth connections"},"inputTableAuditLogSchema":{"allOf":[{"type":"object","required":["writeCatalog","writeSchema"],"properties":{"writeCatalog":{"type":"string","description":"Catalog or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}],"description":"Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection."},"enableHiveMetastore":{"type":"boolean","description":"Set to `true` to see and use your `hive_metastore` catalog in Sigma. Defaults to `false`. If you omit this field in an update request, Sigma resets it to `false`.","title":"Enable Hive metastore"},"pythonComputeClusterId":{"type":"string","description":"ID of the all-purpose compute cluster used to run Python queries. Must be set together with `usePython`. If you omit this field in an update request, Sigma clears the Python configuration.","title":"Compute cluster ID"}}}],"description":"Details of the Databricks connection.","title":"Databricks"},{"allOf":[{"type":"object","required":["type","user","password","host","port"],"properties":{"type":{"type":"string","enum":["mysql"]},"user":{"type":"string"},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]},"host":{"type":"string"},"port":{"type":"number"}}},{"type":"object","properties":{"writeAccess":{"type":"object","required":["writeSchema"],"properties":{"writeSchema":{"type":"string"}}}}}],"description":"Details of the MySQL connection.","title":"MySQL"},{"allOf":[{"type":"object","required":["type","server","database"],"properties":{"type":{"type":"string","enum":["azuresql"],"description":"Azure SQL DB connection type."},"server":{"type":"string","description":"Fully qualified Azure SQL DB server name."},"database":{"type":"string","description":"Database to connect to on the Azure SQL DB server."}}},{"type":"object","required":["server","port","user","password"],"properties":{"server":{"type":"string","description":"Fully qualified server name or host."},"port":{"type":"number","description":"Port for the database server."},"user":{"type":"string","description":"Username used to authenticate to the database."},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Password used to authenticate to the database. This value is write-only and is not returned by the API."}}},{"type":"object","properties":{"useReadUncommittedIsolation":{"type":"boolean","description":"Whether queries run with READ UNCOMMITTED transaction isolation."},"writeAccess":{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database to contain tables written back to the data platform."},"writeSchema":{"type":"string","description":"Schema to contain tables written back to the data platform."}},"description":"Configure write-back for the connection."}}}],"description":"Details of the Azure SQL DB connection.","title":"Azure SQL DB"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["sqlserver"],"description":"SQL Server connection type."}}},{"type":"object","required":["server","port","user","password"],"properties":{"server":{"type":"string","description":"Fully qualified server name or host."},"port":{"type":"number","description":"Port for the database server."},"user":{"type":"string","description":"Username used to authenticate to the database."},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Password used to authenticate to the database. This value is write-only and is not returned by the API."}}},{"type":"object","properties":{"useReadUncommittedIsolation":{"type":"boolean","description":"Whether queries run with READ UNCOMMITTED transaction isolation."},"writeAccess":{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database to contain tables written back to the data platform."},"writeSchema":{"type":"string","description":"Schema to contain tables written back to the data platform."}},"description":"Configure write-back for the connection."}}}],"description":"Details of the SQL Server connection.","title":"SQL Server"},{"allOf":[{"type":"object","required":["type","host","port","user","password"],"properties":{"type":{"type":"string","enum":["starburst"],"description":"Starburst connection type."},"host":{"type":"string","description":"The address of your Starburst Galaxy cluster as a URL or an IP address."},"port":{"type":"number","description":"The port through which Sigma connects to your Starburst Galaxy cluster."},"user":{"type":"string","description":"The username of the service account set up by your Starburst administrator."},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API."}}},{"type":"object","properties":{"writeAccess":{"type":"object","required":["writeCatalog","writeSchema"],"properties":{"writeCatalog":{"type":"string","description":"Catalog to contain tables written back to the data platform."},"writeSchema":{"type":"string","description":"Schema to contain tables written back to the data platform."}},"description":"Configure write-back for the connection."}}}],"description":"Details of the Starburst connection.","title":"Starburst"}]},"name":{"type":"string"}}},{"type":"object","properties":{"description":{"type":"object","additionalProperties":{}},"poolSizes":{"type":"object","properties":{"isPoolConfigured":{"type":"boolean","description":"Whether custom connection pool sizes are configured. If any pool size is supplied without this field, the API stores it as true."},"adhocPoolSize":{"type":"number","description":"Pool size for ad hoc query workloads."},"schedulePoolSize":{"type":"number","description":"Pool size for scheduled workloads."},"catalogPoolSize":{"type":"number","description":"Pool size for catalog workloads."},"resultPoolSize":{"type":"number","description":"Pool size for result cache workloads."}},"description":"Connection pool sizes. Each pool bounds how many queries of a given type (ad hoc, scheduled, catalog, result cache) run concurrently against the warehouse."},"timeoutSecs":{"type":"number"},"useFriendlyNames":{"type":"boolean"}}}]}}}},"responses":{"201":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["organizationId","connectionId","isSample","isAuditLog","lastActiveAt","name","type","useOauth","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"organizationId":{"type":"string","description":"Unique identifier of the organization"},"connectionId":{"type":"string","description":"Unique identifier of the connection"},"isSample":{"type":"boolean","description":"Whether the connection is the Sigma sample data connection"},"isAuditLog":{"type":"boolean","description":"Whether audit logging is enabled"},"lastActiveAt":{"type":"string","format":"date-time","description":"Last activity date and time"},"name":{"type":"string","description":"Name of the connection"},"type":{"type":"string","description":"Type of the connection (e.g., \"bigQuery\")"},"useOauth":{"type":"boolean","description":"Whether OAuth is used"},"createdBy":{"type":"string","description":"Identifier of the user who created this connection"},"updatedBy":{"type":"string","description":"Identifier of the user or process that last updated this connection"},"createdAt":{"type":"string","format":"date-time","description":"When the connection was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the connection was last updated"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether the connection is archived"},"account":{"type":"string","description":"Account associated with the connection"},"warehouse":{"type":"string","description":"Warehouse associated with the connection"},"user":{"type":"string","description":"User associated with the connection"},"httpPath":{"type":"string","description":"For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path."},"role":{"type":"string","description":"Role used by the connection user"},"timeout":{"allOf":[{"type":"object","required":["default"],"properties":{"default":{"type":"number"}}},{"type":"object","properties":{"worksheet":{"type":"number"},"dashboard":{"type":"number"},"download":{"type":"number"}}}],"description":"Timeout settings for the connection, with a default value in seconds"},"poolSizes":{"type":"object","properties":{"isPoolConfigured":{"type":"boolean"},"adhocPoolSize":{"type":"number"},"catalogPoolSize":{"type":"number"},"resultPoolSize":{"type":"number"},"schedulePoolSize":{"type":"number"}},"description":"Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize"},"writeAccess":{"type":"boolean"},"friendlyName":{"type":"boolean","description":"Whether friendly names are enabled for this connection"},"writebacks":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for non-OAuth connections"},"writebackSchemas":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for OAuth connections"},"inputTableAuditLogSchema":{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}],"description":"Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection."},"materializationWarehouse":{"type":"string","description":"Warehouse used to run materialization jobs"},"exportsWarehouse":{"type":"string","description":"Warehouse used to run export jobs"},"oauthMetadataUrl":{"type":"string","description":"OAuth metadata URL configured directly on this connection."},"oauthClientId":{"type":"string","description":"Client ID configured directly on this connection."},"oauthScopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes configured directly on this connection."},"oauthIdpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"description":"OAuth provider type configured or inferred for this connection."},"oauthUsePkce":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses PKCE."},"oauthUseJwt":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses JWT bearer token authentication."},"oauthAudience":{"type":"string","description":"Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery."},"isIndependentOAuth":{"type":"boolean","description":"Whether this connection uses connection-level OAuth instead of organization-level OAuth."},"userAttributes":{"type":"object","properties":{"role":{"type":"string"},"warehouse":{"type":"string"}},"description":"User attributes associated with the connection"},"roleSwitching":{"type":"string","enum":["allRoles","disabled"],"description":"Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant for Snowflake OAuth connections."},"enableHiveMetastore":{"type":"boolean","description":"Whether this Databricks connection exposes the `hive_metastore` catalog in Sigma. Only relevant for Databricks connections.","title":"Enable Hive metastore"},"usePython":{"type":"boolean","title":"Enable Python queries"},"pythonComputeClusterId":{"type":"string","description":"ID of the all-purpose compute cluster used to run Python queries. Only relevant for Databricks connections with Python enabled.","title":"Compute cluster ID"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/{connectionId}":{"patch":{"summary":"Update a connection","description":"Update the metadata of a specific connection. This endpoint is deprecated. Instead, use the [PUT endpoint](https://help.sigmacomputing.com/reference/updateconnection).","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateConnectionDeprecated","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"useOauth":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["organizationId","connectionId","isSample","isAuditLog","lastActiveAt","name","type","useOauth","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"organizationId":{"type":"string","description":"Unique identifier of the organization"},"connectionId":{"type":"string","description":"Unique identifier of the connection"},"isSample":{"type":"boolean","description":"Whether the connection is the Sigma sample data connection"},"isAuditLog":{"type":"boolean","description":"Whether audit logging is enabled"},"lastActiveAt":{"type":"string","format":"date-time","description":"Last activity date and time"},"name":{"type":"string","description":"Name of the connection"},"type":{"type":"string","description":"Type of the connection (e.g., \"bigQuery\")"},"useOauth":{"type":"boolean","description":"Whether OAuth is used"},"createdBy":{"type":"string","description":"Identifier of the user who created this connection"},"updatedBy":{"type":"string","description":"Identifier of the user or process that last updated this connection"},"createdAt":{"type":"string","format":"date-time","description":"When the connection was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the connection was last updated"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether the connection is archived"},"account":{"type":"string","description":"Account associated with the connection"},"warehouse":{"type":"string","description":"Warehouse associated with the connection"},"user":{"type":"string","description":"User associated with the connection"},"httpPath":{"type":"string","description":"For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path."},"role":{"type":"string","description":"Role used by the connection user"},"timeout":{"allOf":[{"type":"object","required":["default"],"properties":{"default":{"type":"number"}}},{"type":"object","properties":{"worksheet":{"type":"number"},"dashboard":{"type":"number"},"download":{"type":"number"}}}],"description":"Timeout settings for the connection, with a default value in seconds"},"poolSizes":{"type":"object","properties":{"isPoolConfigured":{"type":"boolean"},"adhocPoolSize":{"type":"number"},"catalogPoolSize":{"type":"number"},"resultPoolSize":{"type":"number"},"schedulePoolSize":{"type":"number"}},"description":"Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize"},"writeAccess":{"type":"boolean"},"friendlyName":{"type":"boolean","description":"Whether friendly names are enabled for this connection"},"writebacks":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for non-OAuth connections"},"writebackSchemas":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for OAuth connections"},"inputTableAuditLogSchema":{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}],"description":"Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection."},"materializationWarehouse":{"type":"string","description":"Warehouse used to run materialization jobs"},"exportsWarehouse":{"type":"string","description":"Warehouse used to run export jobs"},"oauthMetadataUrl":{"type":"string","description":"OAuth metadata URL configured directly on this connection."},"oauthClientId":{"type":"string","description":"Client ID configured directly on this connection."},"oauthScopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes configured directly on this connection."},"oauthIdpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"description":"OAuth provider type configured or inferred for this connection."},"oauthUsePkce":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses PKCE."},"oauthUseJwt":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses JWT bearer token authentication."},"oauthAudience":{"type":"string","description":"Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery."},"isIndependentOAuth":{"type":"boolean","description":"Whether this connection uses connection-level OAuth instead of organization-level OAuth."},"userAttributes":{"type":"object","properties":{"role":{"type":"string"},"warehouse":{"type":"string"}},"description":"User attributes associated with the connection"},"roleSwitching":{"type":"string","enum":["allRoles","disabled"],"description":"Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant for Snowflake OAuth connections."},"enableHiveMetastore":{"type":"boolean","description":"Whether this Databricks connection exposes the `hive_metastore` catalog in Sigma. Only relevant for Databricks connections.","title":"Enable Hive metastore"},"usePython":{"type":"boolean","title":"Enable Python queries"},"pythonComputeClusterId":{"type":"string","description":"ID of the all-purpose compute cluster used to run Python queries. Only relevant for Databricks connections with Python enabled.","title":"Compute cluster ID"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"],"deprecated":true},"get":{"summary":"Get connection details","description":"Get the metadata of a specific connection by connection ID.\n\n### Usage notes\n- Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  ","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getConnection","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["organizationId","connectionId","isSample","isAuditLog","lastActiveAt","name","type","useOauth","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"organizationId":{"type":"string","description":"Unique identifier of the organization"},"connectionId":{"type":"string","description":"Unique identifier of the connection"},"isSample":{"type":"boolean","description":"Whether the connection is the Sigma sample data connection"},"isAuditLog":{"type":"boolean","description":"Whether audit logging is enabled"},"lastActiveAt":{"type":"string","format":"date-time","description":"Last activity date and time"},"name":{"type":"string","description":"Name of the connection"},"type":{"type":"string","description":"Type of the connection (e.g., \"bigQuery\")"},"useOauth":{"type":"boolean","description":"Whether OAuth is used"},"createdBy":{"type":"string","description":"Identifier of the user who created this connection"},"updatedBy":{"type":"string","description":"Identifier of the user or process that last updated this connection"},"createdAt":{"type":"string","format":"date-time","description":"When the connection was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the connection was last updated"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether the connection is archived"},"account":{"type":"string","description":"Account associated with the connection"},"warehouse":{"type":"string","description":"Warehouse associated with the connection"},"user":{"type":"string","description":"User associated with the connection"},"httpPath":{"type":"string","description":"For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path."},"role":{"type":"string","description":"Role used by the connection user"},"timeout":{"allOf":[{"type":"object","required":["default"],"properties":{"default":{"type":"number"}}},{"type":"object","properties":{"worksheet":{"type":"number"},"dashboard":{"type":"number"},"download":{"type":"number"}}}],"description":"Timeout settings for the connection, with a default value in seconds"},"poolSizes":{"type":"object","properties":{"isPoolConfigured":{"type":"boolean"},"adhocPoolSize":{"type":"number"},"catalogPoolSize":{"type":"number"},"resultPoolSize":{"type":"number"},"schedulePoolSize":{"type":"number"}},"description":"Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize"},"writeAccess":{"type":"boolean"},"friendlyName":{"type":"boolean","description":"Whether friendly names are enabled for this connection"},"writebacks":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for non-OAuth connections"},"writebackSchemas":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for OAuth connections"},"inputTableAuditLogSchema":{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}],"description":"Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection."},"materializationWarehouse":{"type":"string","description":"Warehouse used to run materialization jobs"},"exportsWarehouse":{"type":"string","description":"Warehouse used to run export jobs"},"oauthMetadataUrl":{"type":"string","description":"OAuth metadata URL configured directly on this connection."},"oauthClientId":{"type":"string","description":"Client ID configured directly on this connection."},"oauthScopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes configured directly on this connection."},"oauthIdpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"description":"OAuth provider type configured or inferred for this connection."},"oauthUsePkce":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses PKCE."},"oauthUseJwt":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses JWT bearer token authentication."},"oauthAudience":{"type":"string","description":"Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery."},"isIndependentOAuth":{"type":"boolean","description":"Whether this connection uses connection-level OAuth instead of organization-level OAuth."},"userAttributes":{"type":"object","properties":{"role":{"type":"string"},"warehouse":{"type":"string"}},"description":"User attributes associated with the connection"},"roleSwitching":{"type":"string","enum":["allRoles","disabled"],"description":"Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant for Snowflake OAuth connections."},"enableHiveMetastore":{"type":"boolean","description":"Whether this Databricks connection exposes the `hive_metastore` catalog in Sigma. Only relevant for Databricks connections.","title":"Enable Hive metastore"},"usePython":{"type":"boolean","title":"Enable Python queries"},"pythonComputeClusterId":{"type":"string","description":"ID of the all-purpose compute cluster used to run Python queries. Only relevant for Databricks connections with Python enabled.","title":"Compute cluster ID"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]},"delete":{"summary":"Delete a connection","description":"Delete a specific connection by connection ID.\n\n  ### Usage notes\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n    ","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteConnection","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]},"put":{"summary":"Update a connection","description":"Update a specific connection by connection ID. When updating the connection, send any connection details that you want to keep. Retrieve the current state of a connection by calling the [/v2/connections/{connectionId}](https://help.sigmacomputing.com/reference/get-connection) endpoint.\n\n  ### Usage notes\n  - To restore a deleted connection, pass the `restore` parameter.\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n\n      ","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateConnection","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","required":["details","name"],"properties":{"details":{"oneOf":[{"allOf":[{"type":"object","required":["type","host","database"],"properties":{"type":{"type":"string","enum":["postgres","redshift","alloydb"]},"host":{"type":"string"},"database":{"type":"string"}}},{"type":"object","properties":{"user":{"type":"string"},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]},"port":{"type":"number"},"useTls":{"type":"boolean"},"writeAccess":{"type":"object","required":["writeSchema"],"properties":{"writeSchema":{"type":"string"}}}}}],"description":"Details of the PostgreSQL connection.","title":"PostgreSQL"},{"allOf":[{"allOf":[{"type":"object","required":["type","projectId"],"properties":{"type":{"type":"string","enum":["bigQuery"]},"projectId":{"type":"string"}}},{"type":"object","properties":{"additionalProjectIds":{"type":"array","items":{"type":"string"}},"serviceAccount":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}}}]},{"type":"object","properties":{"metadataUrl":{"type":"string","description":"OAuth metadata URL for connection-level OAuth."},"clientId":{"type":"string","description":"Client ID for the OAuth application used by this connection."},"clientSecret":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes to request when users authenticate to this connection."},"idpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"type":"null","description":"OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown."},"usePkce":{"type":["boolean","null"],"description":"Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE."},"useJwt":{"type":["boolean","null"],"description":"Whether the OAuth flow should use JWT bearer token authentication instead of a client secret."}}},{"type":"object","properties":{"useOauth":{"type":"boolean","description":"Whether this BigQuery connection uses OAuth federation."},"audience":{"type":"string","description":"Google workforce identity federation audience used to exchange the OAuth token for a Google access token."},"writeAccess":{"type":"object","required":["writeProject","writeDataset"],"properties":{"writeProject":{"type":"string"},"writeDataset":{"type":"string"}}}}}],"description":"Details of the BigQuery connection.","title":"Google BigQuery"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["snowflake"]}}},{"type":"object","properties":{"server":{"type":"string"},"account":{"type":"string"},"host":{"type":"string"},"warehouse":{"type":"string"},"role":{"type":"string"},"authType":{"type":"string","enum":["basic-auth","key-pair","oauth"]}}},{"oneOf":[{"type":"object","required":["user","password"],"properties":{"user":{"type":"string"},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}},"description":"Set up basic authentication for the connection","title":"Basic Authentication"},{"allOf":[{"type":"object","required":["user","privateKey"],"properties":{"user":{"type":"string"},"privateKey":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}}},{"type":"object","properties":{"privateKeyPassphrase":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}}}],"description":"Set up key-pair authentication for the connection","title":"Key-Pair Authentication"},{"type":"object","required":["useOauth"],"properties":{"useOauth":{"type":"boolean","enum":[true]}},"description":"Set up OAuth for the connection","title":"OAuth"}]},{"type":"object","properties":{"usePython":{"type":"boolean"},"pythonSecrets":{"type":"object","properties":{"setupUser":{"allOf":[{"type":"object","required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}}},{"type":"object","properties":{"role":{"type":"string"}}}]},"pythonUser":{"allOf":[{"type":"object","required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}}},{"type":"object","properties":{"role":{"type":"string"}}}]}}},"pythonProperties":{"type":"object","properties":{"serviceNames":{"type":"array","items":{"type":"string"}},"externalAccessIntegration":{"type":"string"}}}}},{"type":"object","properties":{"useSourceSwapPolicy":{"type":"boolean"},"sourceSwapPolicyId":{"type":"string"}}}]},{"type":"object","properties":{"metadataUrl":{"type":"string","description":"OAuth metadata URL for connection-level OAuth."},"clientId":{"type":"string","description":"Client ID for the OAuth application used by this connection."},"clientSecret":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes to request when users authenticate to this connection."},"idpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"type":"null","description":"OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown."},"usePkce":{"type":["boolean","null"],"description":"Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE."},"useJwt":{"type":["boolean","null"],"description":"Whether the OAuth flow should use JWT bearer token authentication instead of a client secret."}}},{"type":"object","properties":{"exportsWarehouse":{"type":"string","description":"Warehouse to use for export workloads."},"writeAccess":{"oneOf":[{"allOf":[{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"materializationWarehouse":{"type":"string","description":"Warehouse to use for materialization workloads"},"useDynamicTables":{"type":"boolean","description":"Whether to use Snowflake dynamic tables for materialization workloads."}}}],"description":"","title":"Set write location and materialization warehouse"},{"type":"object","properties":{"materializationWarehouse":{"type":"string","description":"Warehouse to use for materialization workloads"},"useDynamicTables":{"type":"boolean","description":"Whether to use Snowflake dynamic tables for materialization workloads."}},"description":"","title":"Set materialization warehouse"}],"description":"Specify write access for non-OAuth connections"},"userAttributes":{"type":"object","properties":{"role":{"type":"string"},"warehouse":{"type":"string"}}},"writebackSchemas":{"type":"array","items":{"allOf":[{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the write-back destination"},"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for OAuth connections"},"inputTableAuditLogSchema":{"allOf":[{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}],"description":"Specify a schema for input table write access logs"},"pythonProperties":{"type":"object","properties":{"externalAccessIntegration":{"type":"string","description":"Name of the Snowflake external access integration to enable for Python."},"warehouse":{"type":"string","description":"Warehouse to use to run Python code."},"packages":{"type":"string","description":"Comma-separated list of Python packages to install."}},"description":"Python configuration for this Snowflake connection."},"roleSwitching":{"type":"string","enum":["allRoles","disabled"],"description":"Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant when `useOauth` is true."}}}],"description":"Details of the Snowflake connection.","title":"Snowflake"},{"allOf":[{"allOf":[{"type":"object","required":["type","host"],"properties":{"type":{"type":"string","enum":["databricks"]},"host":{"type":"string"}}},{"oneOf":[{"type":"object","required":["endpoint"],"properties":{"endpoint":{"type":"string"}}},{"type":"object","required":["userAttributes"],"properties":{"userAttributes":{"type":"object","required":["endpoint"],"properties":{"endpoint":{"type":"string"}}}}}]},{"oneOf":[{"type":"object","required":["token"],"properties":{"token":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]}},"description":"Set up basic authentication for the connection","title":"Basic Authentication"},{"type":"object","required":["useOauth"],"properties":{"useOauth":{"type":"boolean","enum":[true]}},"description":"Set up OAuth for the connection","title":"OAuth"}]},{"type":"object","properties":{"workspaceUrl":{"type":"string"},"useSourceSwapPolicy":{"type":"boolean"},"sourceSwapPolicyId":{"type":"string"},"usePython":{"type":"boolean","description":"Set to `true` to enable Python queries on this Databricks connection. Requires `pythonComputeClusterId`.","title":"Use Python"}}}]},{"type":"object","properties":{"metadataUrl":{"type":"string","description":"OAuth metadata URL for connection-level OAuth."},"clientId":{"type":"string","description":"Client ID for the OAuth application used by this connection."},"clientSecret":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API."},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes to request when users authenticate to this connection."},"idpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"type":"null","description":"OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, aws_databricks, azure_databricks, gcp_databricks, and unknown."},"usePkce":{"type":["boolean","null"],"description":"Whether the OAuth flow should require Proof Key for Code Exchange (PKCE). Databricks-hosted OAuth providers require PKCE."},"useJwt":{"type":["boolean","null"],"description":"Whether the OAuth flow should use JWT bearer token authentication instead of a client secret."}}},{"type":"object","properties":{"writeAccess":{"type":"object","required":["writeCatalog","writeSchema"],"properties":{"writeCatalog":{"type":"string","description":"Catalog or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}},"description":"Configure write-back for non-OAuth connections"},"writebackSchemas":{"type":"array","items":{"allOf":[{"type":"object","required":["writeCatalog","writeSchema"],"properties":{"writeCatalog":{"type":"string","description":"Catalog or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the write-back destination"},"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for OAuth connections"},"inputTableAuditLogSchema":{"allOf":[{"type":"object","required":["writeCatalog","writeSchema"],"properties":{"writeCatalog":{"type":"string","description":"Catalog or top-level object to contain tables written back to the data platform"},"writeSchema":{"type":"string","description":"Schema or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}],"description":"Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection."},"enableHiveMetastore":{"type":"boolean","description":"Set to `true` to see and use your `hive_metastore` catalog in Sigma. Defaults to `false`. If you omit this field in an update request, Sigma resets it to `false`.","title":"Enable Hive metastore"},"pythonComputeClusterId":{"type":"string","description":"ID of the all-purpose compute cluster used to run Python queries. Must be set together with `usePython`. If you omit this field in an update request, Sigma clears the Python configuration.","title":"Compute cluster ID"}}}],"description":"Details of the Databricks connection.","title":"Databricks"},{"allOf":[{"type":"object","required":["type","user","password","host","port"],"properties":{"type":{"type":"string","enum":["mysql"]},"user":{"type":"string"},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}]},"host":{"type":"string"},"port":{"type":"number"}}},{"type":"object","properties":{"writeAccess":{"type":"object","required":["writeSchema"],"properties":{"writeSchema":{"type":"string"}}}}}],"description":"Details of the MySQL connection.","title":"MySQL"},{"allOf":[{"type":"object","required":["type","server","database"],"properties":{"type":{"type":"string","enum":["azuresql"],"description":"Azure SQL DB connection type."},"server":{"type":"string","description":"Fully qualified Azure SQL DB server name."},"database":{"type":"string","description":"Database to connect to on the Azure SQL DB server."}}},{"type":"object","required":["server","port","user","password"],"properties":{"server":{"type":"string","description":"Fully qualified server name or host."},"port":{"type":"number","description":"Port for the database server."},"user":{"type":"string","description":"Username used to authenticate to the database."},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Password used to authenticate to the database. This value is write-only and is not returned by the API."}}},{"type":"object","properties":{"useReadUncommittedIsolation":{"type":"boolean","description":"Whether queries run with READ UNCOMMITTED transaction isolation."},"writeAccess":{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database to contain tables written back to the data platform."},"writeSchema":{"type":"string","description":"Schema to contain tables written back to the data platform."}},"description":"Configure write-back for the connection."}}}],"description":"Details of the Azure SQL DB connection.","title":"Azure SQL DB"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["sqlserver"],"description":"SQL Server connection type."}}},{"type":"object","required":["server","port","user","password"],"properties":{"server":{"type":"string","description":"Fully qualified server name or host."},"port":{"type":"number","description":"Port for the database server."},"user":{"type":"string","description":"Username used to authenticate to the database."},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Password used to authenticate to the database. This value is write-only and is not returned by the API."}}},{"type":"object","properties":{"useReadUncommittedIsolation":{"type":"boolean","description":"Whether queries run with READ UNCOMMITTED transaction isolation."},"writeAccess":{"type":"object","required":["writeDatabase","writeSchema"],"properties":{"writeDatabase":{"type":"string","description":"Database to contain tables written back to the data platform."},"writeSchema":{"type":"string","description":"Schema to contain tables written back to the data platform."}},"description":"Configure write-back for the connection."}}}],"description":"Details of the SQL Server connection.","title":"SQL Server"},{"allOf":[{"type":"object","required":["type","host","port","user","password"],"properties":{"type":{"type":"string","enum":["starburst"],"description":"Starburst connection type."},"host":{"type":"string","description":"The address of your Starburst Galaxy cluster as a URL or an IP address."},"port":{"type":"number","description":"The port through which Sigma connects to your Starburst Galaxy cluster."},"user":{"type":"string","description":"The username of the service account set up by your Starburst administrator."},"password":{"oneOf":[{"type":"string"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["plain"]},"value":{"type":"string"}}},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API."}}},{"type":"object","properties":{"writeAccess":{"type":"object","required":["writeCatalog","writeSchema"],"properties":{"writeCatalog":{"type":"string","description":"Catalog to contain tables written back to the data platform."},"writeSchema":{"type":"string","description":"Schema to contain tables written back to the data platform."}},"description":"Configure write-back for the connection."}}}],"description":"Details of the Starburst connection.","title":"Starburst"}]},"name":{"type":"string"}}},{"type":"object","properties":{"description":{"type":"object","additionalProperties":{}},"poolSizes":{"type":"object","properties":{"isPoolConfigured":{"type":"boolean","description":"Whether custom connection pool sizes are configured. If any pool size is supplied without this field, the API stores it as true."},"adhocPoolSize":{"type":"number","description":"Pool size for ad hoc query workloads."},"schedulePoolSize":{"type":"number","description":"Pool size for scheduled workloads."},"catalogPoolSize":{"type":"number","description":"Pool size for catalog workloads."},"resultPoolSize":{"type":"number","description":"Pool size for result cache workloads."}},"description":"Connection pool sizes. Each pool bounds how many queries of a given type (ad hoc, scheduled, catalog, result cache) run concurrently against the warehouse."},"timeoutSecs":{"type":"number"},"useFriendlyNames":{"type":"boolean"}}}]},{"type":"object","properties":{"restore":{"type":"boolean"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["organizationId","connectionId","isSample","isAuditLog","lastActiveAt","name","type","useOauth","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"organizationId":{"type":"string","description":"Unique identifier of the organization"},"connectionId":{"type":"string","description":"Unique identifier of the connection"},"isSample":{"type":"boolean","description":"Whether the connection is the Sigma sample data connection"},"isAuditLog":{"type":"boolean","description":"Whether audit logging is enabled"},"lastActiveAt":{"type":"string","format":"date-time","description":"Last activity date and time"},"name":{"type":"string","description":"Name of the connection"},"type":{"type":"string","description":"Type of the connection (e.g., \"bigQuery\")"},"useOauth":{"type":"boolean","description":"Whether OAuth is used"},"createdBy":{"type":"string","description":"Identifier of the user who created this connection"},"updatedBy":{"type":"string","description":"Identifier of the user or process that last updated this connection"},"createdAt":{"type":"string","format":"date-time","description":"When the connection was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the connection was last updated"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether the connection is archived"},"account":{"type":"string","description":"Account associated with the connection"},"warehouse":{"type":"string","description":"Warehouse associated with the connection"},"user":{"type":"string","description":"User associated with the connection"},"httpPath":{"type":"string","description":"For Databricks connections, HTTP path of the SQL warehouse. Not included when a user attribute sets the HTTP path."},"role":{"type":"string","description":"Role used by the connection user"},"timeout":{"allOf":[{"type":"object","required":["default"],"properties":{"default":{"type":"number"}}},{"type":"object","properties":{"worksheet":{"type":"number"},"dashboard":{"type":"number"},"download":{"type":"number"}}}],"description":"Timeout settings for the connection, with a default value in seconds"},"poolSizes":{"type":"object","properties":{"isPoolConfigured":{"type":"boolean"},"adhocPoolSize":{"type":"number"},"catalogPoolSize":{"type":"number"},"resultPoolSize":{"type":"number"},"schedulePoolSize":{"type":"number"}},"description":"Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize"},"writeAccess":{"type":"boolean"},"friendlyName":{"type":"boolean","description":"Whether friendly names are enabled for this connection"},"writebacks":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for non-OAuth connections"},"writebackSchemas":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}]},{"type":"object","properties":{"description":{"type":"string","description":"Description for the write-back destination."}}}]},"description":"Configure write-back for OAuth connections"},"inputTableAuditLogSchema":{"allOf":[{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database, catalog, or top-level object to contain tables written back to the data platform"},"schema":{"type":"string","description":"Schema, database, or second-level object to contain tables written back to the data platform"}}},{"type":"object","properties":{"writebackSchemaId":{"type":"string","description":"Unique identifier of the writebackSchema"}}}],"description":"Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection."},"materializationWarehouse":{"type":"string","description":"Warehouse used to run materialization jobs"},"exportsWarehouse":{"type":"string","description":"Warehouse used to run export jobs"},"oauthMetadataUrl":{"type":"string","description":"OAuth metadata URL configured directly on this connection."},"oauthClientId":{"type":"string","description":"Client ID configured directly on this connection."},"oauthScopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes configured directly on this connection."},"oauthIdpType":{"oneOf":[{"type":"string","enum":["aws_databricks"]},{"type":"string","enum":["azure_databricks"]},{"type":"string","enum":["gcp_databricks"]},{"type":"string","enum":["azuread"]},{"type":"string","enum":["auth0"]},{"type":"string","enum":["adfs"]},{"type":"string","enum":["okta"]},{"type":"string","enum":["ping"]},{"type":"string","enum":["snowflake"]},{"type":"string","enum":["unknown"]}],"description":"OAuth provider type configured or inferred for this connection."},"oauthUsePkce":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses PKCE."},"oauthUseJwt":{"type":["boolean","null"],"description":"Whether this connection-level OAuth configuration uses JWT bearer token authentication."},"oauthAudience":{"type":"string","description":"Audience used for OAuth federation, such as the Google workforce identity federation audience for BigQuery."},"isIndependentOAuth":{"type":"boolean","description":"Whether this connection uses connection-level OAuth instead of organization-level OAuth."},"userAttributes":{"type":"object","properties":{"role":{"type":"string"},"warehouse":{"type":"string"}},"description":"User attributes associated with the connection"},"roleSwitching":{"type":"string","enum":["allRoles","disabled"],"description":"Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only relevant for Snowflake OAuth connections."},"enableHiveMetastore":{"type":"boolean","description":"Whether this Databricks connection exposes the `hive_metastore` catalog in Sigma. Only relevant for Databricks connections.","title":"Enable Hive metastore"},"usePython":{"type":"boolean","title":"Enable Python queries"},"pythonComputeClusterId":{"type":"string","description":"ID of the all-purpose compute cluster used to run Python queries. Only relevant for Databricks connections with Python enabled.","title":"Compute cluster ID"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/{connectionId}/dbtArtifacts":{"post":{"summary":"Add dbt metadata for a connection","description":"Add dbt run artifacts for a given connection. For more details, see [Configure dbt Core integration](/docs/manage-dbt-integration#configure-dbt-core-integration-beta).\n\n  ### Usage notes\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - Create a tar.gz file containing the target directory of your dbt project that contains run artifacts.\n  - Provide the file in the request with the field name 'artifacts'.\n    ","parameters":[{"name":"connectionId","schema":{"type":"string","description":"Unique identifier of the connection","title":"Connection ID"},"in":"path","required":true}],"operationId":"postConnectionDbtArtifacts","requestBody":{"description":"The request body.","content":{"multipart/form-data":{"schema":{"type":"object","required":["artifacts"],"properties":{"artifacts":{"type":"string","format":"binary","description":"Compressed (tar.gz) file containing the artifacts of a dbt run."}},"title":"dbt run artifacts"}}}},"responses":{"201":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/{connectionId}/grants":{"post":{"summary":"Add grants to a connection","description":"Add grants to grant permissions on a connection to specific users or teams.\n\n  ### Usage notes\n  - See [Data permissions overview](https://help.sigmacomputing.com/docs/data-permissions-overview) for details about permissions that can be granted on a connection.\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - Specify the team or user IDs to grant permissions:\n\n    - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n    - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n\n  ### Usage scenarios\n  - Grant a specific team `Can use` access to a connection. ","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"createConnectionGrant","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","items":{"type":"object","required":["grantee","permission"],"properties":{"grantee":{"oneOf":[{"type":"object","required":["memberId"],"properties":{"memberId":{"type":"string"}},"description":"The UUID of the member receiving the grant","title":"Member"},{"type":"object","required":["teamId"],"properties":{"teamId":{"type":"string"}},"description":"The UUID of the team receiving the grant","title":"Team"}]},"permission":{"type":"string","enum":["annotate","usage"],"description":"Connection permissions of Can Use & Annotate and Can Use.","title":"Connection permissions"}}}}},"title":"Connection grant creation request"}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"https://help.sigmacomputing.com/docs/manage-data-permissions","description":"Sigma API documentation:"},"tags":["connections"]},"get":{"summary":"List grants for a connection","description":"Get a list of permissions granted to users or teams on a specific connection.\n\n### Usage notes\n- Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  ","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listConnectionGrants","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["grantId","inodeId","organizationId","memberId","teamId","permission","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"grantId":{"type":"string","description":"The unique identifier of the grant"},"inodeId":{"type":"string","description":"The unique identifier of the inode"},"organizationId":{"type":"string","description":"The unique identifier of the organization"},"memberId":{"type":["string","null"],"description":"The unique identifier of the member"},"teamId":{"type":["string","null"],"description":"The unique identifier of the team"},"permission":{"oneOf":[{"type":"string","enum":["admin","annotate","update","usage","writeback"],"description":"Valid inode types: table, connection database, and connection schema.","title":"Connection Permission"},{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"],"description":"Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.","title":"Inode Permission"},{"type":"string","enum":["view","edit","apply"],"description":"Valid inode types: version tag.","title":"Version Tag Permission"}],"description":"The permission granted to the member"},"createdBy":{"type":"string","description":"The identifier of the user who created this grant"},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this grant"},"createdAt":{"type":"string","format":"date-time","description":"When the grant was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the grant was last updated"}},"title":"Connection grant response"},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"https://help.sigmacomputing.com/docs/manage-data-permissions","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/{connectionId}/grants/{grantId}":{"delete":{"summary":"Delete a grant for a connection","description":"Deletes a specific permission granted on a specific connection.\n\n  ### Usage notes\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n\n  ### Usage scenarios\n  - **Principle of least privilege**: Reduce the permissions granted to specific users and teams on a connection to only what is needed.\n  - **User offboarding**: Remove connection permissions granted to a user that will be deactivated.\n    ","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true},{"name":"grantId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteConnectionGrant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/{connectionId}/sync":{"post":{"summary":"Sync a connection by path","description":"\n  Sync the connection for a data source to retrieve any changes from the data warehouse.\n\n  ### Usage notes\n  - Specify the path to a table, stored procedure, schema, or database in your data warehouse that you want to sync. To trigger a full connection sync, provide an empty path (`[]`).\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - Different connections support different paths:\n\n    - For a Snowflake connection, you can specify `DATABASE.SCHEMA.TABLE`, `DATABASE.SCHEMA.STORED_PROCEDURE`, or a less-specific path.\n    - For Amazon Redshift, you can specify `SCHEMA.TABLE`, `SCHEMA.STORED_PROCEDURE`, or a less-specific path.\n    - For Databricks, you can specify `CATALOG.SCHEMA.TABLE` or a less-specific path.\n    ","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true},{"name":"useServiceAccount","schema":{"type":"boolean","description":"Whether to use the OAuth connection's service account to perform the sync."},"in":"query"}],"operationId":"syncConnectionPath","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["path"],"properties":{"path":{"oneOf":[{"type":"array","minItems":3,"maxItems":3,"items":{"type":"string","description":"Database name","title":"Database"},"description":"Represents a path of the form `DATABASE.SCHEMA.TABLE` or `DATABASE.SCHEMA.STORED_PROCEDURE`.","title":"Table or Object Path"},{"type":"array","minItems":2,"maxItems":2,"items":{"type":"string","description":"Database Name","title":"Database"},"description":"Represents a path of the form `DATABASE.SCHEMA`.","title":"Schema Path"},{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","description":"Database Name","title":"Database"},"description":"Represents a path of the form `DATABASE`.","title":"Database Path"},{"type":"array","items":{},"maxItems":0,"description":"Empty path to sync the entire connection.","title":"Empty Path"}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/{connectionId}/test":{"get":{"summary":"Test a connection","description":"Test whether an existing connection allows read and write operations for the user associated with the API credentials.\n\n  ### Usage notes\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n      ","parameters":[{"name":"connectionId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"testConnection","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["read","write"],"properties":{"read":{"oneOf":[{"type":"string","enum":["SUCCESS"]},{"type":"string","enum":["FAILED"]}]},"write":{"oneOf":[{"type":"string","enum":["DISABLED"]},{"type":"string","enum":["SUCCESS"]},{"type":"string","enum":["FAILED"]}]}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/paths":{"get":{"summary":"List connection paths","description":"List all paths for all connections available to the user.\n\n  ### Usage notes\n  - Call this endpoint to retrieve the specific databases, catalogs, schemas, and tables available to the user associated with the API credentials.\n  - Pass `connectionId` to restrict results to a single connection.\n    ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"connectionId","schema":{"type":"string","description":"Restrict results to paths within this connection.","title":"Connection ID"},"in":"query"}],"operationId":"listConnectionPaths","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["connectionId","urlId","path"],"properties":{"connectionId":{"type":"string"},"urlId":{"type":"string"},"path":{"oneOf":[{"type":"array","minItems":3,"maxItems":3,"items":{"type":"string","description":"Database name","title":"Database"},"description":"Represents a path of the form `DATABASE.SCHEMA.TABLE` or `DATABASE.SCHEMA.STORED_PROCEDURE`.","title":"Table or Object Path"},{"type":"array","minItems":2,"maxItems":2,"items":{"type":"string","description":"Database Name","title":"Database"},"description":"Represents a path of the form `DATABASE.SCHEMA`.","title":"Schema Path"},{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","description":"Database Name","title":"Database"},"description":"Represents a path of the form `DATABASE`.","title":"Database Path"},{"type":"array","items":{},"maxItems":0,"description":"Empty path to sync the entire connection.","title":"Empty Path"}]}}},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/paths/{connectionPathId}/grants":{"post":{"summary":"Add grants to a connection path","description":"Add a grant to a specific connection path to grant permissions for users or teams.\n\n  ### Usage notes\n  - Retrieve the **connectionPathId** by calling the [/v2/connection/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint and using the `inodeId` included in the response, or by calling the [/v2/connections/paths](https://help.sigmacomputing.com/reference/list-connection-paths) endpoint and using the `urlId` included in the response.\n  - Specify the team or user IDs to grant permissions:\n\n    - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n    - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n    ","parameters":[{"name":"connectionPathId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"createConnectionPathGrant","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","items":{"type":"object","required":["grantee","permission"],"properties":{"grantee":{"oneOf":[{"type":"object","required":["memberId"],"properties":{"memberId":{"type":"string"}},"description":"The UUID of the member receiving the grant","title":"Member"},{"type":"object","required":["teamId"],"properties":{"teamId":{"type":"string"}},"description":"The UUID of the team receiving the grant","title":"Team"}]},"permission":{"type":"string","enum":["annotate","usage"]}}}}},"title":"Connection path grant creation request"}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"https://help.sigmacomputing.com/docs/manage-data-permissions","description":"Sigma API documentation:"},"tags":["connections"]},"get":{"summary":"List grants for a connection path","description":"Get a list of permissions granted to a specific connection path.\n\n  ### Usage notes\n  - Retrieve the **connectionPathId** by calling the [/v2/connection/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint and using the `inodeId` included in the response, or by calling the [/v2/connections/paths](https://help.sigmacomputing.com/reference/list-connection-paths) endpoint and using the `urlId` included in the response.\n  ","parameters":[{"name":"connectionPathId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listConnectionPathGrants","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["grantId","inodeId","organizationId","memberId","teamId","permission","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"grantId":{"type":"string","description":"The unique identifier of the grant"},"inodeId":{"type":"string","description":"The unique identifier of the inode"},"organizationId":{"type":"string","description":"The unique identifier of the organization"},"memberId":{"type":["string","null"],"description":"The unique identifier of the member"},"teamId":{"type":["string","null"],"description":"The unique identifier of the team"},"permission":{"oneOf":[{"type":"string","enum":["admin","annotate","update","usage","writeback"],"description":"Valid inode types: table, connection database, and connection schema.","title":"Connection Permission"},{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"],"description":"Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.","title":"Inode Permission"},{"type":"string","enum":["view","edit","apply"],"description":"Valid inode types: version tag.","title":"Version Tag Permission"}],"description":"The permission granted to the member"},"createdBy":{"type":"string","description":"The identifier of the user who created this grant"},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this grant"},"createdAt":{"type":"string","format":"date-time","description":"When the grant was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the grant was last updated"}},"title":"Connection grant response"}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"https://help.sigmacomputing.com/docs/manage-data-permissions","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/paths/{connectionPathId}/grants/{grantId}":{"delete":{"summary":"Delete a grant for a connection path","description":"Delete a specific permission granted to a specific connection path for a user or team.\n\n  ### Usage notes\n  - Retrieve the **connectionPathId** by calling the [/v2/connection/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint and using the `inodeId` included in the response, or by calling the [/v2/connections/paths](https://help.sigmacomputing.com/reference/list-connection-paths) endpoint and using the `urlId` included in the response.\n  - Retrieve the **grantId** by calling the [/v2/connections/paths/{connectionPathId}/grants](https://help.sigmacomputing.com/reference/list-connection-path-grants) endpoint.\n  ","parameters":[{"name":"connectionPathId","schema":{"type":"string"},"in":"path","required":true},{"name":"grantId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteConnectionPathGrant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"https://help.sigmacomputing.com/docs/manage-data-permissions","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/paths/{inodeId}":{"get":{"summary":"Get connection path for a table","description":"Get the connection path for a specific table. If the inodeId is not for a table, this endpoint returns an error.\n\n  ### Usage notes\n  - Retrieve the **inodeId** by calling the [/v2/workbooks/{workbookId}/sources](https://help.sigmacomputing.com/reference/get-workbook-sources) or [/v2/datasets/{datasetId}/source](https://help.sigmacomputing.com/reference/get-dataset-sources) endpoint.\n    ","parameters":[{"name":"inodeId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getInodeConnectionPath","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string"},"path":{"oneOf":[{"type":"array","minItems":3,"maxItems":3,"items":{"type":"string","description":"Database name","title":"Database"},"description":"Represents a path of the form `DATABASE.SCHEMA.TABLE` or `DATABASE.SCHEMA.STORED_PROCEDURE`.","title":"Table or Object Path"},{"type":"array","minItems":2,"maxItems":2,"items":{"type":"string","description":"Database Name","title":"Database"},"description":"Represents a path of the form `DATABASE.SCHEMA`.","title":"Schema Path"},{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","description":"Database Name","title":"Database"},"description":"Represents a path of the form `DATABASE`.","title":"Database Path"},{"type":"array","items":{},"maxItems":0,"description":"Empty path to sync the entire connection.","title":"Empty Path"}]}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/connections/tables/{tableId}/columns":{"get":{"summary":"List columns for a warehouse table","description":"Returns column names, types, and other details for a table in a data warehouse connection.\n\n### Usage notes\n- Retrieve the **tableId** by first calling the [/v2/connections/paths](https://help.sigmacomputing.com/reference/list-connection-paths) endpoint to discover available paths, then calling the [/v2/connection/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint with the path to the desired table and using the `inodeId` included in the response.","parameters":[{"name":"tableId","schema":{"type":"string"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listConnectionTableColumns","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["name","type","visibility"],"properties":{"name":{"type":"string","description":"The name of the column in the warehouse table."},"type":{"type":"object","description":"The column's data type, represented as a recursive type object."},"visibility":{"type":"string","enum":["included","hidden","removed"],"description":"Visibility of the column. If \"included\", the column is visible. If \"hidden\", the column is hidden but available to be used. If \"removed\", the column has been deleted from the table."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the column, if one has been set."}}}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v2/credentials":{"post":{"summary":"Create API credentials","description":"Create API client credentials for a given user. To make this request, your API client credentials must be associated with a Sigma admin user for the same Sigma organization.\n\n  **Important:** The response includes sensitive information. Ensure that you securely store and handle the returned `clientId` and `clientSecret`. These credentials grant access to your Sigma account and should never be exposed publicly or shared unnecessarily.\n\n  ### Usage Notes:\n  - Retrieve the **ownerId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint and using the `memberId` included in the response.","parameters":[],"operationId":"createCredentials","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["ownerId","name"],"properties":{"ownerId":{"type":"string","description":"Unique identifier of the user."},"name":{"type":"string","description":"Name of the credentials."}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the credentials"}}},{"type":"object","properties":{"scopes":{"type":"array","items":{"type":"string","enum":["api","embed"]},"description":"Scopes to assign to the credentials. If not provided, defaults to \"api\"."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["clientId","clientSecret"],"properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["credentials"]},"get":{"summary":"List API credentials","description":"List the API client credentials created for users in your Sigma organization.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update credentials for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.\n- `clientSecret` is never included in the response. It is returned only once, at creation time, in the response to [POST /v2/credentials](https://help.sigmacomputing.com/reference/create-credentials).\n- `ownerId` identifies the user the credentials were created for and `createdBy` identifies the admin who created them.\n\n### Usage scenarios\n- **Credential auditing:** Review which API credentials exist in your organization and who owns each one.\n- **Credential cleanup:** Look up a credential's `clientId` before revoking it with [DELETE /v2/credentials/{clientId}](https://help.sigmacomputing.com/reference/delete-credentials).","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listCredentials","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["clientId","ownerId","name","description","createdAt","createdBy","scopes"],"properties":{"clientId":{"type":"string","description":"Client ID of the credentials."},"ownerId":{"type":"string","description":"Unique identifier of the user assigned the credentials."},"name":{"type":"string","description":"Name of the credentials."},"description":{"type":"string","description":"Description of the credentials"},"createdAt":{"type":"string","format":"date-time","description":"When the credentials were created."},"createdBy":{"type":"string","description":"Unique identifier of the user who created the credentials."},"scopes":{"type":"array","items":{"type":"string","enum":["api","embed"]},"description":"Scopes assigned to the credentials."}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["credentials"]}},"/v2/credentials/{clientId}":{"delete":{"summary":"Delete API credentials","description":"Revoke the API client credentials associated with a given client ID. To make this request, your API client credentials must be associated with a Sigma admin user for the same Sigma organization.","parameters":[{"name":"clientId","schema":{"type":"string","description":"Client ID of the credentials."},"in":"path","required":true}],"operationId":"deleteCredentials","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["credentials"]}},"/v2/dataModels":{"get":{"summary":"List data models","description":"This endpoint retrieves a list of all data models available. You can use the response from this endpoint to review existing data models and determine if there are duplicates or gaps.\n\n### Usage notes\nThis endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.\n\nUsers with the Admin account type can optionally retrieve all data models in the organization.\n\n#### Pagination\nThis endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:\n- hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.\n- total: The total number of entries available across all pages.\n- nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.\n\n#### Example response for pagination\n{\n  \"hasMore\": true,\n  \"total\": 104,\n  \"nextPage\": \"50\"\n}\nTo request additional pages, include the `nextPage` option in your followup request according to the endpoint's parameter requirements. This process can be repeated until the `nextPage` option returns `null`, indicating that no further data is available.\n\n### Usage scenarios\n- **Data model navigation:** Allows users to easily navigate through their available of data models and access the one they need.\n- **Track lineage**: Identify dependencies and lineage of data sources and data models.\n","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"excludeTags","schema":{"type":"boolean","description":"Whether to exclude additional information about tagged versions of each result"},"in":"query"},{"name":"skipPermissionCheck","schema":{"type":"boolean","description":"Only available to Sigma admins. Return all data models, regardless of whether the user has access."},"in":"query"}],"operationId":"listDataModels","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["dataModelId"],"properties":{"dataModelId":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"}}},{"type":"object","required":["dataModelUrlId","name","url","path","latestVersion","ownerId"],"properties":{"dataModelUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}}}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}":{"get":{"summary":"Get a data model","description":"Get details of a specific data model by `dataModelId`.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"excludeTags","schema":{"type":"boolean","description":"Whether to exclude additional information about tagged versions of each result"},"in":"query"}],"operationId":"getDataModel","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["dataModelId"],"properties":{"dataModelId":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"}}},{"type":"object","required":["dataModelUrlId","name","url","path","latestVersion","ownerId"],"properties":{"dataModelUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}}}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}:materialize":{"post":{"summary":"Run a scheduled materialization for a data model element","description":"This endpoint runs a scheduled materialization for an element in a data model. Materialization processes the data of the specified element, allowing the data to be stored or cached for optimized access and performance.\n\n  For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n  ### Usage notes\n  - The materialization schedule for the specified element must be created beforehand.\n  - Retrieve the **sheetId** by calling the [/v2/dataModels/{dataModelId}/materializationSchedules](https://help.sigmacomputing.com/reference/list-data-model-materialization-schedules) endpoint.\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n\n  ### Usage scenarios\n  - **Performance optimization:** Use this endpoint to improve response times for frequently accessed data model elements.\n  - **Data refresh:** Allows users to manually (programmatically) refresh the data of specific data model elements to ensure that the latest data is available for analysis and reporting.\n\n  ### Best practices\n  - Prioritize materialization for elements that are heavily used or form critical components of business reports.\n  - Monitor the performance impacts of materialization and adjust strategies as necessary to optimize resource usage and response times.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true}],"operationId":"materializeDataModelElement","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["sheetId"],"properties":{"sheetId":{"type":"string","description":"Identifier for the materialization schedule of this element.","title":"Sheet ID"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["materializationId"],"properties":{"materializationId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/columns":{"get":{"summary":"List columns for all elements in a data model","description":"This endpoint retrieves all columns in a data model for all elements in the data model.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n\n  ### Usage scenarios\n  - **Data exploration:** Enable users to explore the data structure of a data model element, facilitating deeper analysis and understanding.\n  - **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately.\n\n  ### Best practices\n  - Use this endpoint when setting up interfaces that require specific knowledge about the data structure.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getDataModelColumns","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["columnId","name","formula","type","elementId"],"properties":{"columnId":{"type":"string","description":"Column ID"},"name":{"type":"string","description":"Column name"},"formula":{"type":"string","description":"Column formula or source column reference."},"type":{"type":"object","description":"The column's data type, represented as a recursive type object."},"elementId":{"type":"string","description":"Element ID"}}}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/elements":{"get":{"summary":"List elements in a data model","description":"This endpoint retrieves details of all elements in a data model, which helps you understand and interact with the individual components that make up the data model, such as tables or controls.\n### Usage notes\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- To retrieve elements from version-tagged data models, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/dataModels/{dataModelId}/tags](https://help.sigmacomputing.com/reference/list-data-model-tags) endpoint and using the `tags.name` included in the response for a given data model.\n### Usage scenarios\n- **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation.\n- **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with.\n### Best practices\n- Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"tagName","schema":{"type":"string"},"in":"query"}],"operationId":"listDataModelElements","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"columns":{"type":"array","items":{"type":"string"}},"vizualizationType":{"type":"string"},"error":{"type":"string"}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules":{"get":{"summary":"List column-level security rules on a data model element (Beta)","description":"This endpoint retrieves the column security rules used to configure [column-level security (CLS)](https://help.sigmacomputing.com/docs/column-level-security) on a specific element in a data model. Each rule identifies the columns it protects and the criteria that determine which users can view those columns.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user with **Can edit** access to the data model.\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- Retrieve the **elementId** by calling the [/v2/dataModels/{dataModelId}/elements](https://help.sigmacomputing.com/reference/list-data-model-elements) endpoint.\n- A rule's `columns` is either a list of column identifiers, or the string `all`, which means the rule applies to every column in the element, including columns added in the future.\n- A rule's `criteria` describes who can view the restricted columns: no one (`no-one-can-view`), specific users and teams (`specific-users-and-teams`), or users assigned a matching user attribute value (`user-attribute`).\n\n### Usage scenarios\n- **Security review:** Allows administrators and data modelers to audit which columns are restricted on an element and who is permitted to view them.\n- **Integration points:** Useful for building governance tooling that needs to report on or reconcile column-level access across data models.\n","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the data model element.","title":"Element ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listDataModelElementColumnSecurityRules","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["columnSecurityRuleId","columns","criteria"],"properties":{"columnSecurityRuleId":{"type":"string","description":"The identifier of the column security rule."},"columns":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string","enum":["all"]}],"description":"The columns restricted by the column security rule, represented as either a list of column identifiers or `all`. The `all` value includes every current and future column in the element."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"title":"User Attribute"}]}}},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]},"post":{"summary":"Create column-level security rules on a data model element (Beta)","description":"This endpoint creates one or more [column security rules](https://help.sigmacomputing.com/docs/column-level-security) on a specific element in a data model. Column security rules (also referred to as column-level security, or CLS) restrict the specified columns and grant access according to the provided criteria. All rules are added in a single new version of the data model.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user with **Can edit** access to the data model.\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- Retrieve the **elementId** by calling the [/v2/dataModels/{dataModelId}/elements](https://help.sigmacomputing.com/reference/list-data-model-elements) endpoint.\n- The request body is an array of rules. For each rule, set `columns` to a list of column identifiers to restrict a fixed set of columns, or to the string `all` to restrict every column in the element, including columns added in the future.\n- Set `criteria` to describe who can view the restricted columns: no one (`no-one-can-view`), specific users and teams (`specific-users-and-teams`), or users assigned a matching user attribute value (`user-attribute`).\n- The created rules are returned with their generated `columnSecurityRuleId`. Publishing the rules creates a new version of the data model. If any rule is invalid, no rules are created.\n\n### Usage scenarios\n- **Access governance:** Allows administrators and data modelers to programmatically restrict sensitive columns on a data model element.\n- **Automation:** Useful for provisioning column-level security as part of a broader data governance or onboarding workflow.\n","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the data model element.","title":"Element ID"},"in":"path","required":true}],"operationId":"createDataModelElementColumnSecurityRules","requestBody":{"description":"The column security rules to create on the element.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["columns","criteria"],"properties":{"columns":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string","enum":["all"]}],"description":"The columns restricted by the column security rule, represented as either a list of column identifiers or `all`. The `all` value includes every current and future column in the element."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"title":"User Attribute"}]}}},"description":"The column security rules to create on the element."}}}},"responses":{"200":{"description":"The column security rules that were created, each with its generated identifier.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["columnSecurityRuleId","columns","criteria"],"properties":{"columnSecurityRuleId":{"type":"string","description":"The identifier of the column security rule."},"columns":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string","enum":["all"]}],"description":"The columns restricted by the column security rule, represented as either a list of column identifiers or `all`. The `all` value includes every current and future column in the element."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"title":"User Attribute"}]}}},"description":"The column security rules that were created, each with its generated identifier."}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules/{columnSecurityRuleId}":{"put":{"summary":"Update a column-level security rule on a data model element (Beta)","description":"This endpoint replaces the columns and access criteria for an existing [column-level security (CLS) rule](https://help.sigmacomputing.com/docs/column-level-security) on a specific element in a data model.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user with **Can edit** access to the data model.\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- Retrieve the **elementId** by calling the [/v2/dataModels/{dataModelId}/elements](https://help.sigmacomputing.com/reference/list-data-model-elements) endpoint.\n- Retrieve the **columnSecurityRuleId** by calling the [/v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules](https://help.sigmacomputing.com/reference/list-data-model-element-column-security-rules) endpoint.\n- This is a full replacement of the rule: provide the complete `columns` and `criteria`. Set `columns` to a list of column identifiers, or to the string `all` to restrict every column in the element, including columns added in the future.\n- Set `criteria` to describe who can view the restricted columns: no one (`no-one-can-view`), specific users and teams (`specific-users-and-teams`), or users assigned a matching user attribute value (`user-attribute`).\n- The updated rule is returned with its `columnSecurityRuleId`.\n\n### Usage scenarios\n- **Access governance:** Allows administrators and data modelers to programmatically adjust which columns are restricted on a data model element and who can view them.\n- **Automation:** Useful for reconciling column-level security as part of a broader data governance or onboarding workflow.\n","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the data model element.","title":"Element ID"},"in":"path","required":true},{"name":"columnSecurityRuleId","schema":{"type":"string","description":"The identifier of the column security rule.","title":"Column Security Rule ID"},"in":"path","required":true}],"operationId":"updateDataModelElementColumnSecurityRule","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["columns","criteria"],"properties":{"columns":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string","enum":["all"]}],"description":"The columns restricted by the column security rule, represented as either a list of column identifiers or `all`. The `all` value includes every current and future column in the element."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"title":"User Attribute"}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["columnSecurityRuleId","columns","criteria"],"properties":{"columnSecurityRuleId":{"type":"string","description":"The identifier of the column security rule."},"columns":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string","enum":["all"]}],"description":"The columns restricted by the column security rule, represented as either a list of column identifiers or `all`. The `all` value includes every current and future column in the element."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"title":"User Attribute"}]}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]},"delete":{"summary":"Delete a column-level security rule from a data model element (Beta)","description":"This endpoint deletes an existing [column-level security (CLS) rule](https://help.sigmacomputing.com/docs/column-level-security) from a specific element in a data model.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user with **Can edit** access to the data model.\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- Retrieve the **elementId** by calling the [/v2/dataModels/{dataModelId}/elements](https://help.sigmacomputing.com/reference/list-data-model-elements) endpoint.\n- Retrieve the **columnSecurityRuleId** by calling the [/v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules](https://help.sigmacomputing.com/reference/list-data-model-element-column-security-rules) endpoint.\n\n### Usage scenarios\n- **Access governance:** Allows administrators and data modelers to programmatically remove column restrictions that are no longer required.\n- **Automation:** Useful for reconciling column-level security as part of a broader data governance or offboarding workflow.\n","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the data model element.","title":"Element ID"},"in":"path","required":true},{"name":"columnSecurityRuleId","schema":{"type":"string","description":"The identifier of the column security rule.","title":"Column Security Rule ID"},"in":"path","required":true}],"operationId":"deleteDataModelElementColumnSecurityRule","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules":{"post":{"summary":"Create a materialization schedule for a data model element (Beta)","description":"This endpoint creates a materialization schedule for an element in a data model. The scheduled run materializes the element's data on the given cadence, allowing the data to be stored or cached for optimized access and performance.\n\n  For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n  **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n  - Retrieve the **elementId** by calling the [/v2/dataModels/{dataModelId}/elements](https://help.sigmacomputing.com/reference/list-data-model-elements) endpoint.\n  - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.\n  - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.\n  - An element can have at most one materialization schedule.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Identifier of the data model element to materialize on a schedule. Must be an element, such as a table, that can be materialized.","title":"Element ID"},"in":"path","required":true}],"operationId":"createDataModelMaterializationSchedule","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["schedule"],"properties":{"schedule":{"allOf":[{"type":"object","required":["cronSpec"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."}}},{"type":"object","properties":{"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. Defaults to the organization timezone."}}}],"description":"When to run the materialization.","title":"Schedule"}}}}}},"responses":{"201":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["sheetId","elementId","elementName","schedule","configuredAt","paused"],"properties":{"sheetId":{"type":"string","description":"Identifier of the materialization schedule for the element","title":"Sheet ID"},"elementId":{"type":"string","description":"Identifier of the element being materialized","title":"Element ID"},"elementName":{"type":"string"},"schedule":{"type":["object","null"],"properties":{"cronSpec":{"type":"string","description":"Cron expression to use for the schedule"},"timezone":{"type":"string","description":"Timezone code, for example, PST"}}},"configuredAt":{"type":"string","format":"date-time"},"paused":{"type":"boolean"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]},"patch":{"summary":"Update a materialization schedule for a data model element (Beta)","description":"This endpoint updates the schedule of an existing materialization schedule for an element in a data model. Only the cron cadence and timezone are changed; the element must already have a materialization schedule.\n\n  For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n  **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n  - Retrieve the **elementId** by calling the [/v2/dataModels/{dataModelId}/elements](https://help.sigmacomputing.com/reference/list-data-model-elements) endpoint.\n  - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.\n  - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.\n  - The element must already have a materialization schedule. To create one, use the [create data model materialization schedule](https://help.sigmacomputing.com/reference/create-data-model-materialization-schedule) endpoint.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Identifier of the data model element to materialize on a schedule. Must be an element, such as a table, that can be materialized.","title":"Element ID"},"in":"path","required":true}],"operationId":"patchDataModelMaterializationSchedule","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["schedule"],"properties":{"schedule":{"allOf":[{"type":"object","required":["cronSpec"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."}}},{"type":"object","properties":{"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. Defaults to the organization timezone."}}}],"description":"When to run the materialization.","title":"Schedule"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["sheetId","elementId","elementName","schedule","configuredAt","paused"],"properties":{"sheetId":{"type":"string","description":"Identifier of the materialization schedule for the element","title":"Sheet ID"},"elementId":{"type":"string","description":"Identifier of the element being materialized","title":"Element ID"},"elementName":{"type":"string"},"schedule":{"type":["object","null"],"properties":{"cronSpec":{"type":"string","description":"Cron expression to use for the schedule"},"timezone":{"type":"string","description":"Timezone code, for example, PST"}}},"configuredAt":{"type":"string","format":"date-time"},"paused":{"type":"boolean"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]},"delete":{"summary":"Delete a materialization schedule for a data model element (Beta)","description":"This endpoint deletes the materialization schedule for an element in a data model. Any subsequent scheduled materialization runs for the element are cancelled.\n\n  For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n  **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n  - Retrieve the **elementId** by calling the [/v2/dataModels/{dataModelId}/elements](https://help.sigmacomputing.com/reference/list-data-model-elements) endpoint.\n  - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.\n  - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.\n  - The element must already have a materialization schedule.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Identifier of the data model element to materialize on a schedule. Must be an element, such as a table, that can be materialized.","title":"Element ID"},"in":"path","required":true}],"operationId":"deleteDataModelMaterializationSchedule","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/elements/{elementId}/query":{"get":{"summary":"Get the SQL query for a data model element","description":"This endpoint retrieves the underlying SQL query associated with a specific element in a data model. It allows users to view and understand how the data for that element is being processed and transformed, which is useful for debugging, optimization, and educational purposes.\n\n### Usage notes\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- Retrieve the **elementId** by calling the [/v2/dataModels/{dataModelId}/elements](https://help.sigmacomputing.com/reference/list-data-model-elements) endpoint.\n- To retrieve the query for an element from a version-tagged data model, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/dataModels/{dataModelId}/tags](https://help.sigmacomputing.com/reference/list-data-model-tags) endpoint and using the `tagName` included in the response for a given data model.\n\n### Usage scenarios\n- **Development and debugging:** Provides developers and analysts with the ability to retrieve and review the SQL code behind data model elements, facilitating troubleshooting and enhancements.\n- **Educational insight:** Useful for training purposes or for users learning to understand the impact of various transformations and filters applied within their Sigma data models.\n\n### Best practices\n- Restrict who can retrieve query SQL with [folder and document permissions](https://help.sigmacomputing.com/docs/folder-and-document-permissions). [Column-level security (CLS)](https://help.sigmacomputing.com/docs/column-level-security) still applies to the data returned by those queries.\n- Use this endpoint as part of a regular review process to ensure that all queries are optimized and up to date with current data schemas.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the data model element.","title":"Element ID"},"in":"path","required":true},{"name":"tagName","schema":{"type":"string"},"in":"query"}],"operationId":"getDataModelElementQuery","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"sql":{"type":"string"},"error":{"type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/lineage":{"get":{"summary":"List lineage for a data model","description":"This endpoint lists the elements, data sources, and upstream lineage for those data sources in a data model, providing a detailed view of how data is interconnected within a data model.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n\n  ### Usage scenarios\n  - **Data governance:** Allows data managers to track how information is used and propagated through different data model elements.\n  - **Debugging and optimization:** Helps with identifying and resolving issues in data processing or data model structure.\n  - **Data source management**: Identify the dependencies of data sources in use in a specific data model.\n\n  ### Best practices\n  - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams.\n  - Use this endpoint to regularly audit data model structures, ensuring that all data connections and transformations are correct and optimized.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listDataModelLineageTree","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["sourceIds","elementId","dataSourceIds"],"properties":{"sourceIds":{"type":["array","null"],"items":{"type":"string"},"description":"List of direct sources for the element. Either element IDs or data source IDs."},"elementId":{"type":"string","description":"Unique identifier of the element"},"dataSourceIds":{"type":["array","null"],"items":{"type":"string"},"description":"List of root sources for the element as data source IDs."}}}],"description":"","title":"Element details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["dataModelId"],"properties":{"dataModelId":{"type":"string"}}}],"description":"","title":"Source data model details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["inodeId"],"properties":{"inodeId":{"type":"string"}}}],"description":"","title":"Source table or dataset (deprecated) details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["definition"],"properties":{"definition":{"type":"string","description":"","title":"Custom SQL definition"}}}],"description":"","title":"Source custom SQL details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["csvId"],"properties":{"csvId":{"type":"string","description":"Unique identifier of the uploaded CSV file","title":"CSV ID"}}}],"description":"","title":"Source CSV upload details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["semanticViewId","semanticViewTable"],"properties":{"semanticViewId":{"type":"string","description":"Unique identifier of the semantic view","title":"Semantic view ID"},"semanticViewTable":{"type":"string","description":"Name of the table within the semantic view","title":"Semantic view table"}}}],"description":"","title":"Source semantic view details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["sqlDocumentId"],"properties":{"sqlDocumentId":{"type":"string"}}}],"description":"","title":"Source SQL document details (deprecated)"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["worksheetId"],"properties":{"worksheetId":{"type":"string","description":"Unique identifier of the worksheet","title":"Worksheet ID"}}}],"description":"","title":"Source worksheet details (deprecated)"}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/materializations/{materializationId}":{"get":{"summary":"Get a materialization job","description":"This endpoint retrieves details of a specific materialization job. It provides comprehensive information including status, start and completion times, which helps for monitoring and troubleshooting materialization.\n\n### Usage notes\n- Retrieve the **materializationId** by calling the [/v2/dataModels/{dataModelId}:materialize](https://help.sigmacomputing.com/reference/materialize-data-model-element) endpoint.\n\n### Usage scenarios\n- **Job Monitoring:** Enables administrators to track the progress and status of materialization jobs, aiding in operational oversight.\n- **Troubleshooting:** Provides detailed information needed to diagnose and resolve issues in materialization processes.\n\n### Best practices\n- Monitor materialization jobs regularly to detect and resolve issues promptly.\n- Use the detailed information provided by this endpoint to optimize materialization settings and performance.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"materializationId","schema":{"type":"string","description":"Unique identifier of the materialization job","title":"Materialization ID"},"in":"path","required":true}],"operationId":"getDataModelMaterialization","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["materializationId","status"],"properties":{"materializationId":{"type":"string"},"status":{"type":"string"}}},{"type":"object","properties":{"startedAt":{"type":"string","format":"date-time"},"readyAt":{"type":"string","format":"date-time"},"expiredAt":{"type":"string","format":"date-time"},"error":{"type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/materializationSchedules":{"get":{"summary":"List materialization schedules for a data model","description":"\n  This endpoint retrieves a list of all materialization schedules associated with a data model. Each schedule details when and how often specific data model elements are automatically materialized to optimize performance and data freshness.\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n  - To retrieve additional pages of results, use the response of the `nextPageToken` parameter as the `pageToken` query parameter in the following request.\n\n  ### Usage scenarios\n  - **Monitoring and management:** Administrators can monitor and manage the schedules for materialization to ensure optimal system performance.\n  - **Audit and review:** Periodic reviews of materialization schedules can help in assessing the efficiency of data processes and making necessary adjustments.\n\n  ### Best practices\n  - Regularly review materialization schedules to align them with current data usage patterns and business needs.\n  - Use pagination to manage large sets of data and improve response times of API calls.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 500. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listDataModelMaterializationSchedules","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["sheetId","elementId","elementName","schedule","configuredAt","paused"],"properties":{"sheetId":{"type":"string","description":"Identifier of the materialization schedule for the element","title":"Sheet ID"},"elementId":{"type":"string","description":"Identifier of the element being materialized","title":"Element ID"},"elementName":{"type":"string"},"schedule":{"type":["object","null"],"properties":{"cronSpec":{"type":"string","description":"Cron expression to use for the schedule"},"timezone":{"type":"string","description":"Timezone code, for example, PST"}}},"configuredAt":{"type":"string","format":"date-time"},"paused":{"type":"boolean"}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/sources":{"get":{"summary":"List data model sources","description":"List data sources of a data model given the dataModelId. The response can be a dataset (deprecated), table, custom SQL element, or the data model document and specific elements used as a source.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 500. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listDataModelSources","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","dataModelId","elementIds"],"properties":{"type":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string"},"elementIds":{"type":"array","items":{"type":"string"},"description":"IDs of elements that make up this data model’s sources.","title":"Source element IDs"}}},{"type":"object","properties":{"versionTagId":{"type":"string"}}}],"description":"","title":"Data model source"},{"type":"object","required":["type","datasetId"],"properties":{"type":{"type":"string","enum":["dataset"]},"datasetId":{"type":"string"}},"description":"","title":"Dataset source (deprecated)"},{"type":"object","required":["type","tableId"],"properties":{"type":{"type":"string","enum":["table"]},"tableId":{"type":"string"}},"description":"","title":"Table source"},{"type":"object","required":["type","connectionId","definition","customSqlId"],"properties":{"type":{"type":"string","enum":["custom-sql"]},"connectionId":{"type":"string","description":"ID of the connection where the custom SQL element is run."},"definition":{"type":"string","description":"Raw SQL definition for the custom SQL element."},"customSqlId":{"type":"string","description":"Element ID of the custom SQL."}},"title":"Custom SQL element"}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/spec":{"get":{"summary":"Get the code representation of a data model","description":"This endpoint returns a code representation of an existing data model, including metadata and contents. The response can be formatted as either JSON or YAML, and contains a data model's pages, elements, columns, sources, and more. The representation can be used to store, copy, or modify the data model programmatically.\n\nFor more information on managing data models via the Sigma API, see [Manage data models as code](https://help.sigmacomputing.com/docs/manage-data-models-as-code). For more information on using this endpoint, including an end-to-end example, see [Get the code representation of a data model](https://help.sigmacomputing.com/docs/get-the-code-representation-of-a-data-model).\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user with **Can view** access to the data model.\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint. Invalid or nonexistent IDs return an error.\n- The response includes the data sources, metadata, and relationships necessary to recreate the data model. The data itself is not included in the response.\n- To create a new data model from code, use the [/v2/dataModels/spec](https://help.sigmacomputing.com/reference/create-data-model-spec) endpoint.\n- To update an existing data model from code, use the [/v2/dataModels/{dataModelId}/spec](https://help.sigmacomputing.com/reference/update-data-model-spec) endpoint.\n- The default format of the representation is JSON. To receive YAML, add the query parameter `?format=yaml` or the header `Accept: application/yaml`.\n\n### Usage scenarios\n- **Backup and restore**: Developers can use this endpoint to programmatically back up data models and restore them if needed.\n- **Version control**: Developers can use this endpoint to programmatically manage, update, and version control data models between several organizations or tenants.\n- **Administration**: Administrators can use this endpoint to programmatically analyze and govern data models across an organization.\n- **Migration**: Administrators can use this endpoint to programmatically migrate data models between organizations or tenants.\n- **Agentic workflows**: Agents can use these endpoints to directly manage data model contents in code.\n","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"documentVersion","schema":{"type":"integer"},"in":"query"}],"operationId":"getDataModelSpec","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["dataModelId"],"properties":{"dataModelId":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"}}},{"type":"object","required":["name","url","documentVersion","latestDocumentVersion","ownerId","folderId","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"name":{"type":"string","description":"The name of the data model."},"url":{"type":"string","description":"The full URL for the requested document version of the data model."},"documentVersion":{"type":"number","description":"The document version of the data model."},"latestDocumentVersion":{"type":"number","description":"The most recently published document version of the data model."},"ownerId":{"type":"string","description":"The identifier of the user who owns the data model."},"folderId":{"type":"string","description":"The identifier of the folder in which the data model is located."},"createdBy":{"type":"string","description":"The identifier of the user who created the data model."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated the data model."},"createdAt":{"type":"string","format":"date-time","description":"When the data model was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the data model was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the data model."}}},{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the data model."}}},{"allOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["data-model"],"description":"Document kind. Informational field, ignored when creating or updating a document."}}},{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"type":"object","required":["id","name","elements"],"properties":{"id":{"type":"string","description":"The identifier of the page in the data model."},"name":{"type":"string","description":"The name of the page."},"elements":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","kind","columns","source"],"properties":{"id":{"type":"string","description":"The identifier of the table."},"kind":{"type":"string","enum":["table"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The reference or calculation for the column."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Indicates whether or not the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]},"description":"The columns of the table and their formulas."},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"}],"description":"The source of the table."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the table."},"description":{"type":"string","description":"The description of the table."},"metrics":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the metric."},"formula":{"type":"string","description":"The formula defining the metric."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the metric."},"description":{"type":"string","description":"The description of the metric."},"isHighlighted":{"type":"boolean","description":"Indicates whether or not the metric is highlighted."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."},"timeline":{"allOf":[{"type":"object","required":["dateColumnId"],"properties":{"dateColumnId":{"type":"string","description":"The column of date data used to create the metric timeline."}}},{"type":"object","properties":{"truncation":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The precision to truncate the date to."},"comparison":{"allOf":[{"type":"object","required":["comparisonPeriod"],"properties":{"comparisonPeriod":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time period to compare the current metric value against."}}},{"type":"object","properties":{"direction":{"oneOf":[{"type":"string","enum":["higher-is-better"]},{"type":"string","enum":["lower-is-better"]}],"description":"Indicates whether higher or lower comparison values are better for that metric."}}}],"description":"The time period to compare the current metric value against."}}}],"description":"The timeline configuration for the metric."}}}]},"description":"The metrics associated with this table and their configurations."},"metricFolders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the metric folder."},"name":{"type":"string","description":"The name of the metric folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The metric and sub-folder IDs contained within the folder, in display order."}}}]},"description":"The metric folders in the table and their contents."},"metricOrder":{"type":"array","items":{"type":"string"},"description":"A list of metric and metric-folder identifiers that determines display order."},"relationships":{"type":"array","items":{"allOf":[{"type":"object","required":["id","targetElementId","keys"],"properties":{"id":{"type":"string","description":"The identifier of the relationship."},"targetElementId":{"type":"string","description":"The identifier of the table joined to the parent table in the relationship."},"keys":{"type":"array","items":{"type":"object","required":["sourceColumnId","targetColumnId"],"properties":{"sourceColumnId":{"type":"string","description":"The column from the parent table joined in this relationship."},"targetColumnId":{"type":"string","description":"The column from the target table joined in this relationship."}}},"description":"The pairs of source and target column IDs joined in this relationship."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the relationship."},"description":{"type":"string","description":"The description of the relationship."},"relationshipType":{"oneOf":[{"type":"string","enum":["1:1"]},{"type":"string","enum":["1:N"]},{"type":"string","enum":["N:1"]}],"description":"[Private beta] The cardinality of the relationship."}}}]},"description":"The relationships sourced from this table and their targets."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Indicates whether or not the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this table and their configurations."},"folders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the folder."},"name":{"type":"string","description":"The name of the folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The column and folder IDs contained within the folder."}}}]},"description":"The folders in the table and their contents."},"groupings":{"type":"array","items":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the grouping."}}},{"type":"object","properties":{"groupBy":{"type":"array","items":{"type":"string"},"description":"The columns or folders that define the grouping."},"calculations":{"type":"array","items":{"type":"string"},"description":"The calculations applied to the grouping."}}}]},"description":"The groupings in the table and their contents."},"summary":{"type":"array","items":{"type":"string"},"description":"The identifiers of all columns in the table that are summaries."},"order":{"type":"array","items":{"type":"string"},"description":"A list of identifiers that determines the order in which columns and folders are displayed in the UI. Does not include summary columns."},"visibleAsSource":{"type":"boolean","description":"Indicates whether or not the table can be used as a source in other documents."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The direction in which to sort."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"Indicates how the sort order treats null values."}}}]},"description":"The column, direction, and null behavior used to sort the rows of this table."},"columnSecurities":{"type":"array","items":{"type":"object","required":["id","restrictedColumns","criteria"],"properties":{"id":{"type":"string","description":"The identifier of the column security rule."},"restrictedColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns restricted by the column security rule."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"description":"","title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"description":"","title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"description":"","title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"description":"","title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"description":"","title":"User Attribute"}]}}},"description":"A list of the column security rules applied to columns in this table."},"uniqueKeys":{"type":"array","items":{"type":"string"},"description":"[Private beta] The identifiers of the columns that uniquely identify records in the table."}}}],"description":"","title":"Table"},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["checkbox"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Checkbox"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["switch"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Switch"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."},"showOperators":{"type":"boolean","description":"Indicates whether or not to display the control mode in the UI."},"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text-area"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text Area"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter numbers."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number entered in the control."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Number"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter dates."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The date selected in the control, in ISO 8601 or relative format."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}],"description":"","title":"Date Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["top-n"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","required":["source"],"properties":{"source":{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]},{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","properties":{"source":{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]}],"description":"","title":"List values"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["segmented"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"clearLabel":{"type":"string","description":"The text displayed for the clear option if showClearLabel is true."},"showClearLabel":{"type":"boolean","description":"Indicates whether or not to include a clear option in the control."},"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}],"description":"","title":"Manual"},{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"","title":"Source"}],"description":"The source of the possible values in the control."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}],"description":"","title":"Segmented Control"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"source":{"type":"object","required":["source","columnId"],"properties":{"source":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},"columnId":{"type":"string"}}},"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}}],"description":"","title":"Hierarchy"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The comparison operator used by the control."}}},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number selected in the control."}}}],"description":"","title":"Slider"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["range-slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Range Slider"}],"description":"","title":"Control"}]},"description":"The elements on the page."}}},"description":"The pages of the data model and their contents."}}}]}]}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]},"put":{"summary":"Update a data model from a code representation","description":"This endpoint replaces a data model with the contents defined in a code representation. You can programmatically update the data model's structure, metadata, and contents. This creates a new version of the data model, which is accessible from the Sigma UI.\n\nFor more information on managing data models via the Sigma API, see [Manage data models as code](https://help.sigmacomputing.com/docs/manage-data-models-as-code). For more information on using this endpoint, including an end-to-end example, see [Update a data model from a code representation](https://help.sigmacomputing.com/docs/update-a-data-model-from-a-code-representation).\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish data models** permission.\n- To perform this operation, you must use API credentials owned by a user with **Can edit** access to the data model.\n- Retrieve a representation of an existing data model by calling the [/v2/dataModels/{dataModelId}/spec](https://help.sigmacomputing.com/reference/get-data-model-spec) endpoint.\n- To create a new data model from code, use the [/v2/dataModels/spec](https://help.sigmacomputing.com/reference/create-data-model-spec) endpoint.\n- The endpoint only supports updates to the `pages` array and its contents. Additional fields are not required and are ignored in the request body.\n- When `documentVersion` is provided in the request body, the update fails when the data model has changed since that version. If omitted, the update preserves last-write-wins behavior.\n- Partial updates are not supported. You must provide the entire representation of the data model in the request body.\n- The default format of the representation is JSON. To use YAML, add the header `Content-Type: application/yaml`.\n\n### Usage scenarios\n- **Automation**: If you want to update several data models across one or more organizations, or in response to external events, you can use this endpoint to programmatically update the data models.\n- **Integration**: Using this endpoint, you can update data models based on external data sources or integrate Sigma with other tools and platforms.\n- **Version control**: Developers can use this endpoint to programmatically manage, update, and version control data models between several organizations or tenants.\n- **Agentic workflows**: Agents can use these endpoints to directly manage data model contents in code.\n","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true}],"operationId":"updateDataModelSpec","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the data model."}}},{"allOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["data-model"],"description":"Document kind. Informational field, ignored when creating or updating a document."}}},{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"type":"object","required":["id","name","elements"],"properties":{"id":{"type":"string","description":"The identifier of the page in the data model."},"name":{"type":"string","description":"The name of the page."},"elements":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","kind","columns","source"],"properties":{"id":{"type":"string","description":"The identifier of the table."},"kind":{"type":"string","enum":["table"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The reference or calculation for the column."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Indicates whether or not the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]},"description":"The columns of the table and their formulas."},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"}],"description":"The source of the table."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the table."},"description":{"type":"string","description":"The description of the table."},"metrics":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the metric."},"formula":{"type":"string","description":"The formula defining the metric."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the metric."},"description":{"type":"string","description":"The description of the metric."},"isHighlighted":{"type":"boolean","description":"Indicates whether or not the metric is highlighted."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."},"timeline":{"allOf":[{"type":"object","required":["dateColumnId"],"properties":{"dateColumnId":{"type":"string","description":"The column of date data used to create the metric timeline."}}},{"type":"object","properties":{"truncation":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The precision to truncate the date to."},"comparison":{"allOf":[{"type":"object","required":["comparisonPeriod"],"properties":{"comparisonPeriod":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time period to compare the current metric value against."}}},{"type":"object","properties":{"direction":{"oneOf":[{"type":"string","enum":["higher-is-better"]},{"type":"string","enum":["lower-is-better"]}],"description":"Indicates whether higher or lower comparison values are better for that metric."}}}],"description":"The time period to compare the current metric value against."}}}],"description":"The timeline configuration for the metric."}}}]},"description":"The metrics associated with this table and their configurations."},"metricFolders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the metric folder."},"name":{"type":"string","description":"The name of the metric folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The metric and sub-folder IDs contained within the folder, in display order."}}}]},"description":"The metric folders in the table and their contents."},"metricOrder":{"type":"array","items":{"type":"string"},"description":"A list of metric and metric-folder identifiers that determines display order."},"relationships":{"type":"array","items":{"allOf":[{"type":"object","required":["id","targetElementId","keys"],"properties":{"id":{"type":"string","description":"The identifier of the relationship."},"targetElementId":{"type":"string","description":"The identifier of the table joined to the parent table in the relationship."},"keys":{"type":"array","items":{"type":"object","required":["sourceColumnId","targetColumnId"],"properties":{"sourceColumnId":{"type":"string","description":"The column from the parent table joined in this relationship."},"targetColumnId":{"type":"string","description":"The column from the target table joined in this relationship."}}},"description":"The pairs of source and target column IDs joined in this relationship."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the relationship."},"description":{"type":"string","description":"The description of the relationship."},"relationshipType":{"oneOf":[{"type":"string","enum":["1:1"]},{"type":"string","enum":["1:N"]},{"type":"string","enum":["N:1"]}],"description":"[Private beta] The cardinality of the relationship."}}}]},"description":"The relationships sourced from this table and their targets."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Indicates whether or not the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this table and their configurations."},"folders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the folder."},"name":{"type":"string","description":"The name of the folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The column and folder IDs contained within the folder."}}}]},"description":"The folders in the table and their contents."},"groupings":{"type":"array","items":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the grouping."}}},{"type":"object","properties":{"groupBy":{"type":"array","items":{"type":"string"},"description":"The columns or folders that define the grouping."},"calculations":{"type":"array","items":{"type":"string"},"description":"The calculations applied to the grouping."}}}]},"description":"The groupings in the table and their contents."},"summary":{"type":"array","items":{"type":"string"},"description":"The identifiers of all columns in the table that are summaries."},"order":{"type":"array","items":{"type":"string"},"description":"A list of identifiers that determines the order in which columns and folders are displayed in the UI. Does not include summary columns."},"visibleAsSource":{"type":"boolean","description":"Indicates whether or not the table can be used as a source in other documents."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The direction in which to sort."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"Indicates how the sort order treats null values."}}}]},"description":"The column, direction, and null behavior used to sort the rows of this table."},"columnSecurities":{"type":"array","items":{"type":"object","required":["id","restrictedColumns","criteria"],"properties":{"id":{"type":"string","description":"The identifier of the column security rule."},"restrictedColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns restricted by the column security rule."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"description":"","title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"description":"","title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"description":"","title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"description":"","title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"description":"","title":"User Attribute"}]}}},"description":"A list of the column security rules applied to columns in this table."},"uniqueKeys":{"type":"array","items":{"type":"string"},"description":"[Private beta] The identifiers of the columns that uniquely identify records in the table."}}}],"description":"","title":"Table"},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["checkbox"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Checkbox"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["switch"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Switch"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."},"showOperators":{"type":"boolean","description":"Indicates whether or not to display the control mode in the UI."},"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text-area"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text Area"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter numbers."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number entered in the control."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Number"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter dates."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The date selected in the control, in ISO 8601 or relative format."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}],"description":"","title":"Date Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["top-n"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","required":["source"],"properties":{"source":{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]},{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","properties":{"source":{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]}],"description":"","title":"List values"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["segmented"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"clearLabel":{"type":"string","description":"The text displayed for the clear option if showClearLabel is true."},"showClearLabel":{"type":"boolean","description":"Indicates whether or not to include a clear option in the control."},"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}],"description":"","title":"Manual"},{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"","title":"Source"}],"description":"The source of the possible values in the control."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}],"description":"","title":"Segmented Control"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"source":{"type":"object","required":["source","columnId"],"properties":{"source":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},"columnId":{"type":"string"}}},"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}}],"description":"","title":"Hierarchy"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The comparison operator used by the control."}}},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number selected in the control."}}}],"description":"","title":"Slider"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["range-slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Range Slider"}],"description":"","title":"Control"}]},"description":"The elements on the page."}}},"description":"The pages of the data model and their contents."}}}]}]},{"type":"object","properties":{"documentVersion":{"type":"number","description":"When provided, update only if the data model is still at this document version."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["success","dataModelId"],"properties":{"success":{"type":"boolean"},"dataModelId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/swapSources":{"post":{"summary":"Swap data model sources","description":"Swap the data sources used by a data model. You can swap from one connection to another, and/or from one dataset or table to another.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - To map the sources of a specific element, you can use the table or dataset ID:\n\n    - List sources of data model by calling the [/v2/dataModels/{dataModelId}/sources](https://help.sigmacomputing.com/reference/list-data-model-sources) endpoint.\n    - Retrieve table and dataset IDs by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint. Use the `typeFilters` option to filter for table and dataset files. Use `id` field in the response as the `fromId` or `toId`, as relevant.\n\n  - To swap all tables in a connection, set the `swapTables` option to `true`.\n\n    - Use the `paths` option to specify the connection paths to swap. The connection path is a list of strings that represents the path to the table in the cloud data warehouse. For example, `[\"database\", \"schema\", \"table\"]`.\n    - If the table schema is the same in both connections, leave the `paths` option empty to swap all tables in the connection. You can also pass a partial path to swap between databases, catalogs, or schemas.\n    - If `sourceMapping` is provided, those mappings take precedence over the connection swaps.\n    - If `swapTables` is not set to `true`, only Custom SQL elements have their connections changed.\n\n  ### Usage scenarios\n  - **Data model development**: Use a test data source while developing a data model, then swap the source to a production database when ready to share the data model for production use.\n    ","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true}],"operationId":"swapDataModelSources","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"sourceMapping":{"type":"array","items":{"allOf":[{"type":"object","required":["fromId","toId"],"properties":{"fromId":{"type":"string","description":"ID of the dataset (deprecated) or table to swap from.","title":"Data source ID"},"toId":{"type":"string","description":"ID of the dataset (deprecated) or table to swap to.","title":"Data source ID"}}},{"type":"object","properties":{"metricMapping":{"type":"array","items":{"type":"object","required":["fromMetric","toMetric"],"properties":{"fromMetric":{"type":"string","description":"Metric in the data source.","title":"Metric name"},"toMetric":{"type":"string","description":"Metric in the data source.","title":"Metric name"}}}},"columnMapping":{"type":"array","items":{"type":"object","required":["fromColumn","toColumn"],"properties":{"fromColumn":{"oneOf":[{"type":"string","description":"Column in the data source.","title":"Column name"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link of the form [\"link_name\", \"column_name\"]","title":"Link"}]},"toColumn":{"oneOf":[{"type":"string","description":"Column in the data source.","title":"Column name"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link of the form [\"link_name\", \"column_name\"]","title":"Link"}]}}}}}}]}},"connectionMapping":{"type":"array","items":{"allOf":[{"type":"object","required":["fromId","toId"],"properties":{"fromId":{"type":"string","description":"ID of the connection to swap from.","title":"Connection ID"},"toId":{"type":"string","description":"ID of the connection to swap to.","title":"Connection ID"}}},{"type":"object","properties":{"swapTables":{"type":"boolean","description":"Whether to swap all tables in the connection","title":"Swap Tables"},"paths":{"type":"array","items":{"type":"object","required":["fromPath","toPath"],"properties":{"fromPath":{"type":"array","items":{"type":"string"},"description":"Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE']","title":"From Path"},"toPath":{"type":"array","items":{"type":"string"},"description":"Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE']","title":"To Path"}}}}}}]}},"copyInputTableData":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["unswappedSources","unswappedConnections"],"properties":{"unswappedSources":{"type":"array","items":{"type":"string"},"description":"IDs of sources in the workbook that were not swapped."},"unswappedConnections":{"type":"array","items":{"type":"string"},"description":"IDs of custom SQL connections in the workbook that were not swapped."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/{dataModelId}/tags":{"get":{"summary":"List tags for a data model","description":"Retrieve the version tag information for a specific data model.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n\n  ### Usage scenarios\n\n  - Provide on-demand performant access to version tag details for a data model. For example, make a GET request to the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint with the `excludeTags` parameter set to `True` to improve performance, then use this endpoint to return tag information for specific data models.","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listDataModelTags","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/spec":{"post":{"summary":"Create a data model from a code representation","description":"This endpoint creates a new data model in Sigma from a code representation. Use it to programmatically define and create data models that are then accessible from the Sigma UI.\n\nFor more information on managing data models via the Sigma API, see [Manage data models as code](https://help.sigmacomputing.com/docs/manage-data-models-as-code). For more information on using this endpoint, including an end-to-end example, see [Create a data model from a code representation](https://help.sigmacomputing.com/docs/create-a-data-model-from-a-code-representation).\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish data models** permission.\n- Retrieve a representation of an existing data model by calling the [/v2/dataModels/{dataModelId}/spec](https://help.sigmacomputing.com/reference/get-data-model-spec) endpoint.\n- To get a list of folders, call the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and review the `id` field in the response for files with a `type` of `folder`.\n- The default format of the representation is JSON. To use YAML, add the header `Content-Type: application/yaml`.\n\n### Usage scenarios\n- **Automation**: If you want to create several data models across one or more organizations, you can use this endpoint to programmatically create the data models.\n- **Integration**: Using this endpoint, you can create data models based on external data sources or integrate Sigma with other tools and platforms.\n- **Migration**: You can use this endpoint to migrate data models from one organization to another.\n- **Version control**: Developers can use this endpoint to programmatically manage, update, and version control data models between several organizations or tenants.\n- **Agentic workflows**: Agents can use these endpoints to directly manage data model contents in code.\n","parameters":[],"operationId":"createDataModelSpec","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name","folderId"],"properties":{"name":{"type":"string","description":"The name of the data model."},"folderId":{"type":"string","description":"The identifier of the folder in which the data model is located."}}},{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the data model."}}},{"allOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["data-model"],"description":"Document kind. Informational field, ignored when creating or updating a document."}}},{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"type":"object","required":["id","name","elements"],"properties":{"id":{"type":"string","description":"The identifier of the page in the data model."},"name":{"type":"string","description":"The name of the page."},"elements":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","kind","columns","source"],"properties":{"id":{"type":"string","description":"The identifier of the table."},"kind":{"type":"string","enum":["table"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the column."},"formula":{"type":"string","description":"The reference or calculation for the column."}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the column."},"description":{"type":"string","description":"The description of the column."},"hidden":{"type":"boolean","description":"Indicates whether or not the column is hidden from view."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."}}}]},"description":"The columns of the table and their formulas."},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"}],"description":"The source of the table."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the table."},"description":{"type":"string","description":"The description of the table."},"metrics":{"type":"array","items":{"allOf":[{"type":"object","required":["id","formula"],"properties":{"id":{"type":"string","description":"The identifier of the metric."},"formula":{"type":"string","description":"The formula defining the metric."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the metric."},"description":{"type":"string","description":"The description of the metric."},"isHighlighted":{"type":"boolean","description":"Indicates whether or not the metric is highlighted."},"format":{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the number specified in d3 format."},"prefix":{"type":"string","description":"The prefix to apply to the number."},"suffix":{"type":"string","description":"The suffix to apply to the number."},"displayNullAs":{"type":"string","description":"The display value to show for null values."}}},{"type":"object","properties":{"decimalSymbol":{"type":"string","description":"The character used for decimal notation."},"digitGroupingSymbol":{"type":"string","description":"The character used to separate digits in large numbers."},"digitGroupingSize":{"type":"array","items":{"type":"number"},"description":"The interval at which to use the digit grouping symbol."},"currencySymbol":{"type":"string","description":"The characters used for currency."}}}]},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["datetime"]}}},{"type":"object","properties":{"formatString":{"type":"string","description":"The format of the date specified in d3 time format."}}}]}],"description":"The display format of the column."},"timeline":{"allOf":[{"type":"object","required":["dateColumnId"],"properties":{"dateColumnId":{"type":"string","description":"The column of date data used to create the metric timeline."}}},{"type":"object","properties":{"truncation":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The precision to truncate the date to."},"comparison":{"allOf":[{"type":"object","required":["comparisonPeriod"],"properties":{"comparisonPeriod":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]},{"type":"string","enum":["second"]}],"description":"The time period to compare the current metric value against."}}},{"type":"object","properties":{"direction":{"oneOf":[{"type":"string","enum":["higher-is-better"]},{"type":"string","enum":["lower-is-better"]}],"description":"Indicates whether higher or lower comparison values are better for that metric."}}}],"description":"The time period to compare the current metric value against."}}}],"description":"The timeline configuration for the metric."}}}]},"description":"The metrics associated with this table and their configurations."},"metricFolders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the metric folder."},"name":{"type":"string","description":"The name of the metric folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The metric and sub-folder IDs contained within the folder, in display order."}}}]},"description":"The metric folders in the table and their contents."},"metricOrder":{"type":"array","items":{"type":"string"},"description":"A list of metric and metric-folder identifiers that determines display order."},"relationships":{"type":"array","items":{"allOf":[{"type":"object","required":["id","targetElementId","keys"],"properties":{"id":{"type":"string","description":"The identifier of the relationship."},"targetElementId":{"type":"string","description":"The identifier of the table joined to the parent table in the relationship."},"keys":{"type":"array","items":{"type":"object","required":["sourceColumnId","targetColumnId"],"properties":{"sourceColumnId":{"type":"string","description":"The column from the parent table joined in this relationship."},"targetColumnId":{"type":"string","description":"The column from the target table joined in this relationship."}}},"description":"The pairs of source and target column IDs joined in this relationship."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the relationship."},"description":{"type":"string","description":"The description of the relationship."},"relationshipType":{"oneOf":[{"type":"string","enum":["1:1"]},{"type":"string","enum":["1:N"]},{"type":"string","enum":["N:1"]}],"description":"[Private beta] The cardinality of the relationship."}}}]},"description":"The relationships sourced from this table and their targets."},"filters":{"type":"array","items":{"allOf":[{"type":"object","required":["id","columnId"],"properties":{"id":{"type":"string","description":"The identifier of the filter."},"columnId":{"type":"string","description":"The identifier of the column this filter targets."}}},{"type":"object","properties":{"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Indicates whether or not the filter is enabled."}}},{"oneOf":[{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["date-range"]}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date Range"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["top-n"]}}},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}],"description":"","title":"List"},{"allOf":[{"type":"object","required":["kind","mode"],"properties":{"kind":{"type":"string","enum":["text-match"]},"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"value":{"type":"string","description":"The string to compare against."},"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Text Match"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The hierarchy paths selected by the filter."}}}],"description":"","title":"Hierarchy"}]}]},"description":"The filters applied to this table and their configurations."},"folders":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the folder."},"name":{"type":"string","description":"The name of the folder."}}},{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"description":"The column and folder IDs contained within the folder."}}}]},"description":"The folders in the table and their contents."},"groupings":{"type":"array","items":{"allOf":[{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The identifier of the grouping."}}},{"type":"object","properties":{"groupBy":{"type":"array","items":{"type":"string"},"description":"The columns or folders that define the grouping."},"calculations":{"type":"array","items":{"type":"string"},"description":"The calculations applied to the grouping."}}}]},"description":"The groupings in the table and their contents."},"summary":{"type":"array","items":{"type":"string"},"description":"The identifiers of all columns in the table that are summaries."},"order":{"type":"array","items":{"type":"string"},"description":"A list of identifiers that determines the order in which columns and folders are displayed in the UI. Does not include summary columns."},"visibleAsSource":{"type":"boolean","description":"Indicates whether or not the table can be used as a source in other documents."},"sort":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The direction in which to sort."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"Indicates how the sort order treats null values."}}}]},"description":"The column, direction, and null behavior used to sort the rows of this table."},"columnSecurities":{"type":"array","items":{"type":"object","required":["id","restrictedColumns","criteria"],"properties":{"id":{"type":"string","description":"The identifier of the column security rule."},"restrictedColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns restricted by the column security rule."},"criteria":{"oneOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["no-one-can-view"]}},"description":"","title":"No One Can View"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string","description":"The identifier of a Sigma user."}},"description":"","title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string","description":"The identifier of a team."}},"description":"","title":"Team"}]},"description":"The identifiers of the users and teams that can access the columns restricted by the column security rule."}},"description":"","title":"Specific Users and Teams"},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["user-attribute"]},"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"The identifier of a user attribute."},"value":{"type":"string","description":"The value for a user attribute."}}},"description":"The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule."}},"description":"","title":"User Attribute"}]}}},"description":"A list of the column security rules applied to columns in this table."},"uniqueKeys":{"type":"array","items":{"type":"string"},"description":"[Private beta] The identifiers of the columns that uniquely identify records in the table."}}}],"description":"","title":"Table"},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["checkbox"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Checkbox"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["switch"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"allOf":[{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["True/False"]},{"type":"string","enum":["True/All"]}],"description":"The mode of the control."}}},{"type":"object","properties":{"value":{"type":"boolean","description":"The selected value in the control."}}}]}],"description":"","title":"Switch"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["equals"]},{"type":"string","enum":["does-not-equal"]},{"type":"string","enum":["contains"]},{"type":"string","enum":["does-not-contain"]},{"type":"string","enum":["starts-with"]},{"type":"string","enum":["does-not-start-with"]},{"type":"string","enum":["ends-with"]},{"type":"string","enum":["does-not-end-with"]},{"type":"string","enum":["like"]},{"type":"string","enum":["not-like"]},{"type":"string","enum":["matches-regexp"]},{"type":"string","enum":["does-not-match-regexp"]}],"description":"Indicates the type of text comparison to make."}}},{"type":"object","properties":{"case":{"oneOf":[{"type":"string","enum":["sensitive"]},{"type":"string","enum":["insensitive"]}],"description":"Indicates whether the text comparison is case 'sensitive' or 'insensitive'."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."},"showOperators":{"type":"boolean","description":"Indicates whether or not to display the control mode in the UI."},"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["text-area"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"value":{"type":"string","description":"The text entered in the control."}}}],"description":"","title":"Text Area"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter numbers."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number entered in the control."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Number"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Number Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The operator used to filter dates."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The date selected in the control, in ISO 8601 or relative format."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Date"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["date-range"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Indicates whether or not to include the current date."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 or relative format."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 or relative format."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The start date of the date range, in relative format. Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Indicates whether to filter for the relative range before or after the date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago' or 'in x units'."}},"description":"The end date of the date range, in relative format. Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}],"description":"","title":"Date Range"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["top-n"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"oneOf":[{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank"]},{"type":"string","enum":["rank-dense"]},{"type":"string","enum":["row-number"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-n"]},{"type":"string","enum":["bottom-n"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"rowCount":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Row Count"},{"allOf":[{"type":"object","required":["rankingFunction","mode"],"properties":{"rankingFunction":{"oneOf":[{"type":"string","enum":["rank-percentile"]},{"type":"string","enum":["cume-dist"]}],"description":"The type of ranking this filter uses."},"mode":{"oneOf":[{"type":"string","enum":["top-percentile"]},{"type":"string","enum":["bottom-percentile"]}],"description":"Indicates whether to filter top or bottom N values."}}},{"type":"object","properties":{"percentile":{"type":"number","description":"The number of top results to return."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}}],"description":"","title":"Percentile"}]}],"description":"","title":"Top N"},{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","required":["source"],"properties":{"source":{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]},{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["list"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."}}}]},{"type":"object","properties":{"source":{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}]}}},{"oneOf":[{"allOf":[{"type":"object","required":["selectionMode"],"properties":{"selectionMode":{"type":"string","enum":["single"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}]},{"type":"object","properties":{"selectionMode":{"type":"string","enum":["multiple"]},"values":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"boolean"}]},"description":"The list of selected booleans. Can contain null.","title":"boolean"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]},"description":"The list of selected numbers. Can contain null.","title":"number"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]},"description":"The list of selected strings. Can contain null.","title":"string"},{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]},"description":"The list of selected dates in ISO 8601 format. Can contain null.","title":"datetime"}],"description":"The list of selected values in the filter."}}}]}]}],"description":"","title":"List values"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["segmented"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"clearLabel":{"type":"string","description":"The text displayed for the clear option if showClearLabel is true."},"showClearLabel":{"type":"boolean","description":"Indicates whether or not to include a clear option in the control."},"source":{"oneOf":[{"allOf":[{"type":"object","required":["kind","valueType"],"properties":{"kind":{"type":"string","enum":["manual"]},"valueType":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["date"]},{"type":"string","enum":["boolean"]}],"description":"The data type of the list values."}}},{"type":"object","properties":{"values":{"oneOf":[{"type":"array","items":{"type":"boolean"}},{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}},{"type":"array","items":{"type":"string","description":"","title":"Fixed Date"}}],"description":"The list of possible values in the control."},"labels":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The list of labels applied to the values in the control."}}}],"description":"","title":"Manual"},{"allOf":[{"type":"object","required":["kind","source","columnId"],"properties":{"kind":{"type":"string","enum":["source"]},"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The identifier of the column used as a value source for the control."}}},{"type":"object","properties":{"displayColumnId":{"type":"string","description":"The identifier of the column containing display names for the control values."}}}],"description":"","title":"Source"}],"description":"The source of the possible values in the control."}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The value selected in the control."}}}],"description":"","title":"Segmented Control"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["hierarchy"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"source":{"type":"object","required":["source","columnId"],"properties":{"source":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},"columnId":{"type":"string"}}},"mode":{"oneOf":[{"type":"string","enum":["include"]},{"type":"string","enum":["exclude"]}],"description":"Indicates whether to 'include' or 'exclude' the list of values."},"values":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}}],"description":"","title":"Hierarchy"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","required":["mode"],"properties":{"mode":{"oneOf":[{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":[">="]}],"description":"The comparison operator used by the control."}}},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"value":{"type":"number","description":"The number selected in the control."}}}],"description":"","title":"Slider"},{"allOf":[{"allOf":[{"type":"object","required":["kind","id","controlId","controlType"],"properties":{"kind":{"type":"string","enum":["control"]},"id":{"type":"string","description":"The identifier of the control."},"controlId":{"type":"string","description":"The identifier used to reference this control in a formula."},"controlType":{"type":"string","enum":["range-slider"]}}},{"type":"object","properties":{"name":{"type":"string","description":"The display name of the control"},"filters":{"type":"array","items":{"type":"object","required":["source","columnId"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}},"description":"","title":"Table"},{"type":"object","required":["connectionId","kind","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["warehouse-table"]},"path":{"type":"array","items":{"type":"string"},"description":"The path of the table in the data platform."}},"description":"","title":"Warehouse Table"},{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}},"description":"","title":"Data Model"}],"description":"The source targeted by this control."},"columnId":{"type":"string","description":"The column targeted by this control."}}},"description":"The filter targets of the control"},"parameters":{"type":"array","items":{"type":"object","required":["kind","dataModelId","controlId"],"properties":{"kind":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string","description":"The identifier of the data model."},"controlId":{"type":"string","description":"The identifier of the control."}}},"description":"The data model control that this control targets and overrides."}}}]},{"type":"object","properties":{"low":{"type":"number","description":"The minimum value of the slider."},"high":{"type":"number","description":"The maximum value of the slider."},"step":{"type":"number","description":"The amount the slider increments by between steps."},"includeNulls":{"oneOf":[{"type":"string","enum":["always"]},{"type":"string","enum":["never"]},{"type":"string","enum":["when-no-value-is-selected"]}],"description":"Indicates when to include null values."}}},{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}],"description":"","title":"Range Slider"}],"description":"","title":"Control"}]},"description":"The elements on the page."}}},"description":"The pages of the data model and their contents."}}}]}]},{"type":"object","properties":{"description":{"type":"string","description":"The description of the data model."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["success","dataModelId"],"properties":{"success":{"type":"boolean"},"dataModelId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/dataModels/tag":{"post":{"summary":"Tag a data model","description":"Add a version tag to a data model and optionally set up a connection to swap to for a specific version of the data model.\n\n  ### Usage notes\n  - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n  - Retrieve the **tag** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n  - Retrieve the **connectionId** to use as the **fromId** or **toId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - If your data model includes a source that is not mapped to a new source, that source is not swapped.\n  - When swapping data models used as the source for the data model:\n    - You can only swap a data model source to another version of the same data model source. You cannot swap a data model source to a table in your data warehouse or a dataset.\n    - When you swap sources from one data model version to a new one, specify the version tag of the data model that you swap to with `toVersionTagId`:\n      - To swap to the latest published version of the data model, specify `toVersionTagId` as `null`.\n      - To swap to a specific tagged version of the data model, specify the `toVersionTagId` of the data model.\n    - If the data model already uses a specific tagged version of a data model as a source, use `fromVersionTagId` to indicate which tagged version to swap from.\n      - To swap from the latest published version of the data model, specify `fromVersionTagId` as `null`.\n      - To swap from a specific tagged version of the data model, specify the `fromVersionTagId` of the data model.\n  - To retrieve the `fromVersionTagId` for a data model used as the data model source, call the [/v2/dataModels/{dataModelId}/sources](https://help.sigmacomputing.com/reference/list-data-model-sources) endpoint and use the `versionTagId` in the response.\n  - To retrieve the `versionTagId` for a data model, call the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint and use the `versionTagId` in the response.\n\n  ### Usage scenarios\n  - **Lifecycle management**: Identify production and development resources.\n    ","parameters":[],"operationId":"tagDataModel","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["dataModelId","tag"],"properties":{"dataModelId":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"tag":{"type":"string","description":"Name of the version tag to apply.","title":"Version tag name"}}},{"type":"object","properties":{"dataModelVersion":{"type":"number","description":"Specific version of the published data model to tag."},"sourceMappingConfig":{"type":"array","items":{"type":"object","required":["fromConnectionId","toConnectionId","paths"],"properties":{"fromConnectionId":{"type":"string"},"toConnectionId":{"type":"string"},"paths":{"type":"array","items":{"type":"object","required":["fromPath","toPath"],"properties":{"fromPath":{"type":"array","items":{"type":"string"}},"toPath":{"type":"array","items":{"type":"string"}}}}}}},"description":"Swap sources for the data model when you add a tag."},"dataModelSourceTaggedVersions":{"type":"array","items":{"type":"object","required":["dataModelId","fromVersionTagId","toVersionTagId"],"properties":{"dataModelId":{"type":"string"},"fromVersionTagId":{"type":["string","null"]},"toVersionTagId":{"type":["string","null"]}}},"description":"Which tagged version of the data model to use as the source."},"isDefault":{"type":"boolean","description":"Whether to make this tag the default tagged version to load if the user doesn't have access to the published version."}}}]},"examples":{"Request Example":{"value":{"dataModelId":"00000000-0000-0000-0000-000000000000","dataModelVersion":4,"tag":"production","sourceMappingConfig":[{"fromConnectionId":"00000000-0000-0000-0000-000000000000","toConnectionId":"00000000-0000-0000-0000-000000000001","paths":[{"fromPath":["SNOWFLAKE_DEVELOPMENT","WEATHER","DAILY_14_TOTAL"],"toPath":["SNOWFLAKE_PRODUCTION","WEATHER","DAILY_16_TOTAL"]}]}],"isDefault":true}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["versionTagId","taggedDataModelId","taggedDataModelVersion"],"properties":{"versionTagId":{"type":"string"},"taggedDataModelId":{"type":"string","description":"Unique identifier of the data model.","title":"Data model ID"},"taggedDataModelVersion":{"type":"number"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v2/datasets":{"get":{"summary":"List datasets (Deprecated)","description":"Get a list of available datasets. Available datasets include any datasets in your My Documents folder and any datasets you have access to.\n\n **Deprecation notice**: [Datasets](/docs/datasets) are deprecated. As of June 2, 2026, you can no longer create datasets or edit existing datasets. As of September 15, 2026, you can no longer use datasets as a data source. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](/docs/migrate-a-dataset-to-a-data-model).\n\n### Usage notes\n- Retrieve the **ownerId** by calling the [/v2/members](/reference/list-members) endpoint and using the `memberId` included in the response.\n\n ### Usage scenarios\n - **Plan dataset migration**: Review the owner, location (path) of the dataset, migration status, and total number of documents that reference the dataset to plan dataset migration tasks. Pass `ownerId` to scope results to one owner's datasets.\n - **Clean up after dataset migration**: Retrieve the `dataModelId` of the data model created for the dataset. Make a GET request to the [/v2/dataModels/{dataModelId}](https://help.sigmacomputing.com/reference/get-data-model) endpoint to retrieve more details about the created data model.\n - **Identify unused datasets**: Review datasets that have 0 documents referencing it as a source and delete those datasets by making a DELETE request to the [/v2/files/{inodeId}](https://help.sigmacomputing.com/reference/delete-file) endpoint.\n   ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"skipPermissionCheck","schema":{"type":"boolean","description":"Only available to Sigma admins. Return all datasets, regardless of whether the user has access."},"in":"query"},{"name":"ownerId","schema":{"type":"string","description":"Only return datasets owned by this user. Combine with `skipPermissionCheck` to return another user’s datasets as an admin.","title":"Owner ID"},"in":"query"}],"operationId":"listDatasets","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["datasetId","createdBy","updatedBy","createdAt","updatedAt","name","description","url","owner","referenceCount","path","migrationToDataModel","migrationStatus"],"properties":{"datasetId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"owner":{"type":"string"},"referenceCount":{"type":"number","description":"Count of inbound references to the dataset","title":"Reference count"},"path":{"type":"string","description":"Path describing dataset's ancestor workspace and folders","title":"Path"},"migrationToDataModel":{"type":["object","null"],"required":["dataModelId","dataModelUrl","migratedAt","migratedBy"],"properties":{"dataModelId":{"type":"string"},"dataModelUrl":{"type":"string"},"migratedAt":{"type":"string","format":"date-time"},"migratedBy":{"type":"string"}},"description":"Details about migration to data model","title":"Migration to data model"},"migrationStatus":{"type":"string","enum":["migrated","not-migrated","not-required"],"description":"An indicator of the dataset's migration status as displayed on the dataset migration admin page.\n  - `not-required` indicates that the dataset is not used as a data source (in other words, it is not referenced by other documents) and likely does not need to be migrated to a data model.\n  - `migrated` indicates that the dataset has already been migrated to a data model\n  - `not-migrated` indicates that the dataset has not been migrated and is still in use as a data source\n        ","title":"Migration status"}}},{"type":"object","properties":{"isArchived":{"type":"boolean"}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["datasets"]}},"/v2/datasets/{datasetId}":{"get":{"summary":"Get a dataset (Deprecated)","description":"Get a specific dataset by datasetId\n\n  **Deprecation notice**: [Datasets](/docs/datasets) are deprecated. As of June 2, 2026, you can no longer create datasets or edit existing datasets. As of September 15, 2026, you can no longer use datasets as a data source. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](/docs/migrate-a-dataset-to-a-data-model).\n\n  ### Usage notes\n  - Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n  ","parameters":[{"name":"datasetId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getDataset","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["datasetId","createdBy","updatedBy","createdAt","updatedAt","name","description","url","owner","referenceCount","path","migrationToDataModel","migrationStatus"],"properties":{"datasetId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"owner":{"type":"string"},"referenceCount":{"type":"number","description":"Count of inbound references to the dataset","title":"Reference count"},"path":{"type":"string","description":"Path describing dataset's ancestor workspace and folders","title":"Path"},"migrationToDataModel":{"type":["object","null"],"required":["dataModelId","dataModelUrl","migratedAt","migratedBy"],"properties":{"dataModelId":{"type":"string"},"dataModelUrl":{"type":"string"},"migratedAt":{"type":"string","format":"date-time"},"migratedBy":{"type":"string"}},"description":"Details about migration to data model","title":"Migration to data model"},"migrationStatus":{"type":"string","enum":["migrated","not-migrated","not-required"],"description":"An indicator of the dataset's migration status as displayed on the dataset migration admin page.\n  - `not-required` indicates that the dataset is not used as a data source (in other words, it is not referenced by other documents) and likely does not need to be migrated to a data model.\n  - `migrated` indicates that the dataset has already been migrated to a data model\n  - `not-migrated` indicates that the dataset has not been migrated and is still in use as a data source\n        ","title":"Migration status"}}},{"type":"object","properties":{"isArchived":{"type":"boolean"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["datasets"]}},"/v2/datasets/{datasetId}/grants":{"get":{"summary":"Get grants for a dataset (Deprecated)","description":"Get a list of permissions granted to teams and users for a specific dataset.\n\n  **Deprecation notice**: [Datasets](/docs/datasets) are deprecated. As of June 2, 2026, you can no longer create datasets or edit existing datasets. As of September 15, 2026, you can no longer use datasets as a data source. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](/docs/migrate-a-dataset-to-a-data-model).\n\n  ### Usage notes\n  - Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n  ","parameters":[{"name":"datasetId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listDatasetGrants","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["grantId","inodeId","organizationId","memberId","teamId","permission","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"grantId":{"type":"string","description":"The unique identifier of the grant"},"inodeId":{"type":"string","description":"The unique identifier of the inode"},"organizationId":{"type":"string","description":"The unique identifier of the organization"},"memberId":{"type":["string","null"],"description":"The unique identifier of the member"},"teamId":{"type":["string","null"],"description":"The unique identifier of the team"},"permission":{"oneOf":[{"type":"string","enum":["admin","annotate","update","usage","writeback"],"description":"Valid inode types: table, connection database, and connection schema.","title":"Connection Permission"},{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"],"description":"Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.","title":"Inode Permission"},{"type":"string","enum":["view","edit","apply"],"description":"Valid inode types: version tag.","title":"Version Tag Permission"}],"description":"The permission granted to the member"},"createdBy":{"type":"string","description":"The identifier of the user who created this grant"},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this grant"},"createdAt":{"type":"string","format":"date-time","description":"When the grant was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the grant was last updated"}},"title":"Connection grant response"},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["datasets"]},"post":{"summary":"Grant permissions on a dataset (Deprecated)","description":"Grant permissions to a specific dataset for users or teams.\n\n  **Deprecation notice**: [Datasets](/docs/datasets) are deprecated. As of June 2, 2026, you can no longer create datasets or edit existing datasets. As of September 15, 2026, you can no longer use datasets as a data source. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](/docs/migrate-a-dataset-to-a-data-model).\n\n  ### Usage notes\n  - Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n  - Grant permissions to one user or team at a time using the relevant IDs:\n\n    - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n    - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n    ","parameters":[{"name":"datasetId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"createDatasetGrant","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","items":{"allOf":[{"type":"object","required":["grantee","permission"],"properties":{"grantee":{"oneOf":[{"type":"object","required":["memberId"],"properties":{"memberId":{"type":"string"}},"description":"The UUID of the member receiving the grant","title":"Member"},{"type":"object","required":["teamId"],"properties":{"teamId":{"type":"string"}},"description":"The UUID of the team receiving the grant","title":"Team"}]},"permission":{"type":"string","enum":["view","edit"]}}},{"type":"object","properties":{"tagId":{"type":"string"}}}]}}},"title":"Dataset grant creation request"}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["datasets"]}},"/v2/datasets/{datasetId}/grants/{grantId}":{"delete":{"summary":"Delete a permission granted on a dataset (Deprecated)","description":"Delete a permission granted on a specific dataset by grantId.\n\n  **Deprecation notice**: [Datasets](/docs/datasets) are deprecated. As of June 2, 2026, you can no longer create datasets or edit existing datasets. As of September 15, 2026, you can no longer use datasets as a data source. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](/docs/migrate-a-dataset-to-a-data-model).\n\n  ### Usage notes\n  - Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n  - Retrieve the **grantId** by calling the [/v2/datasets/{datasetId}/grants](https://help.sigmacomputing.com/reference/list-dataset-grants) endpoint.\n  ","parameters":[{"name":"datasetId","schema":{"type":"string"},"in":"path","required":true},{"name":"grantId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteDatasetGrant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["datasets"]}},"/v2/datasets/{datasetId}/materialization":{"post":{"summary":"Materialize a dataset (Deprecated)","description":"Start a materialization run for a specific dataset. The materialization schedule for the dataset must already exist.\n\n  **Deprecation notice**: [Datasets](/docs/datasets) are deprecated. As of June 2, 2026, you can no longer create datasets or edit existing datasets. As of September 15, 2026, you can no longer use datasets as a data source. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](/docs/migrate-a-dataset-to-a-data-model).\n\n  ### Usage notes\n  - Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n  ","parameters":[{"name":"datasetId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"materializeDataset","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["taskId"],"properties":{"taskId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["datasets"]},"get":{"summary":"List materializations for a dataset (Deprecated)","description":"List materialization jobs for a dataset.\n\n  **Deprecation notice**: [Datasets](/docs/datasets) are deprecated. As of June 2, 2026, you can no longer create datasets or edit existing datasets. As of September 15, 2026, you can no longer use datasets as a data source. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](/docs/migrate-a-dataset-to-a-data-model).\n\n  ### Usage notes\n  - Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n  ","parameters":[{"name":"datasetId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listDatasetMaterializations","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["status","finishedAt","error","runtimeSecs","numRows","numBytes"],"properties":{"status":{"type":"string","enum":["success","failed","marked","swept"]},"finishedAt":{"type":"string","format":"date-time"},"error":{"allOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":["string","null"]}}},{"type":"object","properties":{"errorCode":{"type":["string","null"]}}}],"type":"null"},"runtimeSecs":{"type":["number","null"]},"numRows":{"type":["number","null"]},"numBytes":{"type":["number","null"]}},"title":"Materialization result"},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["datasets"]}},"/v2/datasets/{datasetId}/migrate":{"post":{"summary":"Migrate a dataset to a data model (Beta)","description":"Migrate a dataset (deprecated) to a data model. The response always includes the dataset's link details and its link and reference counts. For more information on how datasets are migrated to data models, see [Migrate a dataset to a data model](https://help.sigmacomputing.com/docs/migrate-a-dataset-to-a-data-model).\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n- To skip the migration and return only the dataset's link details and its link and reference counts, pass `dryRun: true`.\n\n### Usage scenarios\n- **Plan dataset migration**: Pass `dryRun: true` to review the datasets and connection tables linked to the dataset, and how many documents reference it, before you migrate.\n- **Migrate datasets in bulk**: If you want to migrate several datasets, you can use this endpoint to programmatically migrate the datasets returned by [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) with a `migrationStatus` of `not-migrated`.\n","parameters":[{"name":"datasetId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"migrateDatasetToDataModel","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["shouldUpdateReferences"],"properties":{"shouldUpdateReferences":{"type":"boolean","description":"Whether to update references in workbooks that use this dataset to point to the new data model.","title":"Update references"}}},{"type":"object","properties":{"destFolderId":{"type":"string","description":"Optional destination folder ID where the data model should be created. If not provided, the data model will be created in the same folder as the dataset.","title":"Destination folder ID"},"dryRun":{"type":"boolean","description":"If true, do not perform the migration. Only return the link details and the link and reference counts. Defaults to false.","title":"Dry run"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["dataModelId","links","linkCount","referenceCount"],"properties":{"dataModelId":{"type":["string","null"],"description":"ID of the newly-created data model. Null when `dryRun` is true.","title":"Data model ID"},"links":{"type":"array","items":{"type":"object","required":["source","target"],"properties":{"source":{"oneOf":[{"type":"object","required":["type","datasetId"],"properties":{"type":{"type":"string","enum":["dataset"]},"datasetId":{"type":"string","description":"ID of the dataset.","title":"Dataset ID"}},"description":"A linked dataset.","title":"Dataset"},{"type":"object","required":["type","tableId"],"properties":{"type":{"type":"string","enum":["table"]},"tableId":{"type":"string","description":"ID of the connection table.","title":"Table ID"}},"description":"A linked connection table.","title":"Table"}],"description":"The dataset or table that is the source of the link.","title":"Source"},"target":{"oneOf":[{"type":"object","required":["type","datasetId"],"properties":{"type":{"type":"string","enum":["dataset"]},"datasetId":{"type":"string","description":"ID of the dataset.","title":"Dataset ID"}},"description":"A linked dataset.","title":"Dataset"},{"type":"object","required":["type","tableId"],"properties":{"type":{"type":"string","enum":["table"]},"tableId":{"type":"string","description":"ID of the connection table.","title":"Table ID"}},"description":"A linked connection table.","title":"Table"}],"description":"The dataset or table the link targets.","title":"Target"}}},"description":"All datasets or connection tables linked to this dataset. Each can be a source, target, or part of a series of links.","title":"Links"},"linkCount":{"type":"number","description":"Number of links the dataset has to other datasets.","title":"Link count"},"referenceCount":{"type":"number","description":"Number of references from other datasets to this dataset.","title":"Reference count"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["datasets"]}},"/v2/datasets/{datasetId}/sources":{"get":{"summary":"List dataset sources (Deprecated)","description":"Retrieve the sources of a dataset if the source is a table or a dataset. Returns the inode IDs.\n\n  **Deprecation notice**: [Datasets](/docs/datasets) are deprecated. As of June 2, 2026, you can no longer create datasets or edit existing datasets. As of September 15, 2026, you can no longer use datasets as a data source. Migrate your datasets to data models and update any documents that use datasets as a data source to use a different source. See [Migrate a dataset to a data model](/docs/migrate-a-dataset-to-a-data-model).\n\n  ### Usage notes\n  - Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n  ","parameters":[{"name":"datasetId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getDatasetSources","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["type","inodeId"],"properties":{"type":{"type":"string","enum":["dataset","table"]},"inodeId":{"type":"string"}}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["datasets"]}},"/v2/deploymentPolicies":{"post":{"summary":"Create a deployment policy","description":"Create a deployment policy to define what documents to deploy to a tenant organization and how to swap sources for those documents.\n\n### Usage notes\n- Retrieve the **versionTagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint.\n- Retrieve the identifier for `sourceSwapPolicies` by calling the [/v2/sourceSwapPolicies](https://help.sigmacomputing.com/reference/list-source-swap-policies) endpoint and using the `policyId` in the response.\n    ","parameters":[],"operationId":"createDeployment","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the deployment policy."}}},{"type":"object","properties":{"versionTagId":{"type":"string"},"sourceSwapPolicies":{"type":"array","items":{"type":"string"},"description":"Unique identifiers of the source swap policies used to swap connections when deploying documents."},"nameInTenant":{"type":"string","description":"Name to use for the workspace created by the deployment policy in the receiving tenant."},"copyInputTableData":{"type":"boolean","description":"Whether to copy input table data to receiving tenant organizations when deploying documents. Only applies to input tables that are editable in draft mode. Defaults to false."}}}]},"examples":{"Deploy quarterly sales dashboard":{"value":{"name":"Quarterly Sales Starter Pack","sourceSwapPolicies":["2a6f8b3d-5c1e-4a9b-8d3f-7e2c4b6a9f1d"]}},"Deploy a tagged version":{"value":{"name":"Test Release","nameInTenant":"Latest Build","versionTagId":"c3d7f1a5-6e9b-4c2d-8a1f-3b5e9c7a2d4f","sourceSwapPolicies":["d4e8f2a6-1b7c-4a9d-9e21-6d3f8a5c9b0e"]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["deploymentPolicyId"],"properties":{"deploymentPolicyId":{"type":"string"}}},"examples":{"Deploy quarterly sales dashboard":{"value":{"deploymentPolicyId":"b8e3a7c1-4f2d-4b9e-9a6c-3d5f1e8b2a4c"}},"Deploy a tagged version":{"value":{"deploymentPolicyId":"7a2c5e9f-3b8d-4c1a-9f6e-2d4a8b1c5e7f"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]},"get":{"summary":"List deployment policies","description":"List all deployment policies set up for an organization.\n    ","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 500. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listDeployments","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["deploymentPolicyId","name","nameInTenant","versionTagId","sourceSwapPolicies","copyInputTableData"],"properties":{"deploymentPolicyId":{"type":"string"},"name":{"type":"string","description":"Name of the deployment policy"},"nameInTenant":{"type":"string","description":"Name to use for the workspace created by the deployment policy in the receiving tenant."},"versionTagId":{"oneOf":[{"type":"string"},{"type":"null"}]},"sourceSwapPolicies":{"type":"array","items":{"type":"string"},"description":"Unique identifiers of the source swap policies used to swap connections when deploying documents."},"copyInputTableData":{"type":"boolean","description":"Whether input table data is copied to receiving tenant organizations when deploying documents. Only applies to input tables that are editable in draft mode."}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]}},"/v2/deploymentPolicies/{deploymentPolicyId}":{"get":{"summary":"Get a deployment policy","description":"Get details for a deployment policy.\n\n### Usage notes\n- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.\n    ","parameters":[{"name":"deploymentPolicyId","schema":{"type":"string","description":"Unique identifier of the deployment policy."},"in":"path","required":true}],"operationId":"getDeployment","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["deploymentPolicyId","name","nameInTenant","versionTagId","sourceSwapPolicies","copyInputTableData"],"properties":{"deploymentPolicyId":{"type":"string"},"name":{"type":"string","description":"Name of the deployment policy"},"nameInTenant":{"type":"string","description":"Name to use for the workspace created by the deployment policy in the receiving tenant."},"versionTagId":{"oneOf":[{"type":"string"},{"type":"null"}]},"sourceSwapPolicies":{"type":"array","items":{"type":"string"},"description":"Unique identifiers of the source swap policies used to swap connections when deploying documents."},"copyInputTableData":{"type":"boolean","description":"Whether input table data is copied to receiving tenant organizations when deploying documents. Only applies to input tables that are editable in draft mode."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]},"patch":{"summary":"Update a deployment policy","description":"Update a deployment policy. Only the fields included in the request are changed.\n\n### Usage notes\n- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.\n- Retrieve the identifier for `sourceSwapPolicies` by calling the [/v2/sourceSwapPolicies](https://help.sigmacomputing.com/reference/list-source-swap-policies) endpoint and using the `policyId` in the response.\n- The version tag cannot be changed after a deployment policy is created.\n    ","parameters":[{"name":"deploymentPolicyId","schema":{"type":"string","description":"Unique identifier of the deployment policy."},"in":"path","required":true}],"operationId":"updateDeployment","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the deployment policy."},"nameInTenant":{"type":"string","description":"Name to use for the workspace created by the deployment policy in the receiving tenant."},"sourceSwapPolicies":{"type":"array","items":{"type":"string"},"description":"Unique identifiers of the source swap policies used to swap connections when deploying documents. Replaces the existing set."},"copyInputTableData":{"type":"boolean","description":"Whether to copy input table data to receiving tenant organizations when deploying documents. Only applies to input tables that are editable in draft mode."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["deploymentPolicyId","name","nameInTenant","versionTagId","sourceSwapPolicies","copyInputTableData"],"properties":{"deploymentPolicyId":{"type":"string"},"name":{"type":"string","description":"Name of the deployment policy"},"nameInTenant":{"type":"string","description":"Name to use for the workspace created by the deployment policy in the receiving tenant."},"versionTagId":{"oneOf":[{"type":"string"},{"type":"null"}]},"sourceSwapPolicies":{"type":"array","items":{"type":"string"},"description":"Unique identifiers of the source swap policies used to swap connections when deploying documents."},"copyInputTableData":{"type":"boolean","description":"Whether input table data is copied to receiving tenant organizations when deploying documents. Only applies to input tables that are editable in draft mode."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]},"delete":{"summary":"Archive a deployment policy","description":"Archive a deployment policy.\n\n### Usage notes\n- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.\n    ","parameters":[{"name":"deploymentPolicyId","schema":{"type":"string","description":"Unique identifier of the deployment policy."},"in":"path","required":true}],"operationId":"archiveDeployment","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]}},"/v2/deploymentPolicies/{deploymentPolicyId}/files":{"get":{"summary":"List documents for a deployment policy","description":"List documents for a deployment policy\n\n### Usage notes\n- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.\n- If the user associated with the API key does not have access to the document, the `inode` field is `null`.\n- The `inode` field is one of `workbook`, `dataModel`, `report`, or `folder`. Use the `type` field to determine which shape is returned and which ID field is present.\n- Folders are returned as a single entry. The documents they contain are not listed individually.\n\n### Usage scenarios\n- Review and audit documents deployed to specific tenant organizations.\n    ","parameters":[{"name":"deploymentPolicyId","schema":{"type":"string","description":"Unique identifier of the deployment policy."},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 500. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listInodesForDeployment","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["inodeId","inode","deploymentPolicyId"],"properties":{"inodeId":{"type":"string"},"inode":{"oneOf":[{"oneOf":[{"type":"object","required":["name","type","workbookId"],"properties":{"name":{"type":"string"},"type":{"type":"string","enum":["workbook"]},"workbookId":{"type":"string"}},"description":"","title":"Workbook"},{"type":"object","required":["name","type","dataModelId"],"properties":{"name":{"type":"string"},"type":{"type":"string","enum":["dataModel"]},"dataModelId":{"type":"string"}},"description":"","title":"Data model"},{"type":"object","required":["name","type","reportId"],"properties":{"name":{"type":"string"},"type":{"type":"string","enum":["report"]},"reportId":{"type":"string"}},"description":"","title":"Report"},{"type":"object","required":["name","type","folderId"],"properties":{"name":{"type":"string"},"type":{"type":"string","enum":["folder"]},"folderId":{"type":"string"}},"description":"","title":"Folder"}]},{"type":"null"}]},"deploymentPolicyId":{"type":"string"}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]},"post":{"summary":"Add documents to a deployment policy","description":"Add documents to a deployment policy.\n\n### Usage notes\n- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.\n- To add workbooks to a deployment policy, retrieve the relevant `workbookId` from the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- To add data models to a deployment policy, retrieve the relevant `dataModelId` from the [/v2/datamodels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- To add reports to a deployment policy, retrieve the relevant `reportId` from the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- To add folders to a deployment policy, retrieve the relevant folder ID from the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and review the `id` field in the response for files with a `type` of `folder`.\n- Adding a folder deploys the documents it contains. Templates cannot be added to a deployment policy.\n\n### Usage scenarios\n- Centrally manage documents that are deployed to specific tenant organizations.\n- Deploy an entire folder of documents to tenant organizations without listing each document individually.\n","parameters":[{"name":"deploymentPolicyId","schema":{"type":"string","description":"Unique identifier of the deployment policy."},"in":"path","required":true}],"operationId":"addInodesToDeployment","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["inodeIds"],"properties":{"inodeIds":{"type":"array","items":{"type":"string"},"description":"Unique identifier of the workbook, data model, report, or folder."}}},"examples":{"Deploy quarterly sales dashboard":{"value":{"inodeIds":["6a1d8f3b-2e5c-4b7a-9d1e-4c8b6a3f7e2d"]}},"Deploy a tagged version":{"value":{"inodeIds":["9c3e7a1f-4b6d-4c8a-9e2f-1d5c8b3a6f9e"]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]}},"/v2/deploymentPolicies/{deploymentPolicyId}/files/{inodeId}":{"delete":{"summary":"Remove a document from a deployment policy","description":"Remove a document from a deployment policy.\n\n### Usage notes\n- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](/reference/list-deployments) endpoint.\n- To remove workbooks from a deployment policy, retrieve the relevant `workbookId` from the [/v2/workbooks](/reference/list-workbooks) endpoint.\n- To remove data models from a deployment policy, retrieve the relevant `dataModelId` from the [/v2/datamodels](/reference/list-data-models) endpoint.\n- To remove reports from a deployment policy, retrieve the relevant `reportId` from the [/v2/reports](/reference/list-reports) endpoint.\n- To remove folders from a deployment policy, retrieve the relevant folder ID from the [/v2/files](/reference/list-files) endpoint and review the `id` field in the response for files with a `type` of `folder`.\n\n### Usage scenarios\n- Revoke access to outdated documents from tenant organizations.\n    ","parameters":[{"name":"deploymentPolicyId","schema":{"type":"string"},"in":"path","required":true},{"name":"inodeId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"removeInodesFromDeployment","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]}},"/v2/deploymentPolicies/{deploymentPolicyId}/tenants":{"post":{"summary":"Add a tenant to a deployment policy","description":"Add a tenant to a deployment policy.\n\n### Usage notes\n- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.\n- Retrieve the `tenantId` from the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint.\n\n### Usage scenarios\n- Deploy documents in a deployment policy to a specific tenant organization.\n    ","parameters":[{"name":"deploymentPolicyId","schema":{"type":"string","description":"Unique identifier of a deployment policy."},"in":"path","required":true}],"operationId":"addTenantToDeployment","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["tenantOrganizationId"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of the tenant organization."}}},"examples":{"Add Acme West":{"value":{"tenantOrganizationId":"5e9c2b7a-3f1d-4a8e-9b6c-2d4f8a1e6c3b"}},"Add Acme East":{"value":{"tenantOrganizationId":"1f4a8c3e-6d2b-4e9a-8c1f-5b7d3a2e9f6c"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]},"get":{"summary":"List tenants for a deployment policy","description":"List tenants for a deployment policy.\n\n### Usage notes\n- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.\n\n### Usage scenarios\n- Review and audit documents deployed to specific tenant organizations.\n    ","parameters":[{"name":"deploymentPolicyId","schema":{"type":"string","description":"Unique identifier of the deployment policy."},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 500. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listTenantsForDeployment","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"string"},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]}},"/v2/deploymentPolicies/{deploymentPolicyId}/tenants/{tenantOrganizationId}":{"delete":{"summary":"Remove a tenant from a deployment policy","description":"Remove a tenant from a deployment policy.\n\n### Usage notes\n- Retrieve the `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.\n- Retrieve the `tenantOrganizationId` from the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint or from the [/v2/deploymentPolicies/{deploymentPolicyId}/tenants](https://help.sigmacomputing.com/reference/list-tenants-for-deployment) endpoint.\n\n### Usage scenarios\n- Remove documents in a deployment policy from a tenant organization.\n- Clean up tenant assignments when a tenant is no longer needed.\n    ","parameters":[{"name":"deploymentPolicyId","schema":{"type":"string","description":"Unique identifier of a deployment policy."},"in":"path","required":true},{"name":"tenantOrganizationId","schema":{"type":"string","description":"Unique identifier of the tenant organization."},"in":"path","required":true}],"operationId":"removeTenantFromDeployment","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]}},"/v2/deploymentPolicies/tenants":{"get":{"summary":"List deployable tenant organizations","description":"Returns a paginated list of tenant organizations that the calling organization can deploy to.\n\n- **Parent organizations**: Returns all tenant organizations.\n- **Tenant organizations**: Returns tenant organizations that the calling tenant has been granted deployment capabilities to.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned an account type with the **Manage deployment policies** permission enabled.","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 500. Defaults to 50.","title":"Page size"},"in":"query"},{"name":"search","schema":{"type":"string","description":"Search term to filter tenant organizations by name or slug."},"in":"query"}],"operationId":"listDeployableTenants","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["tenantOrganizationId","tenantOrganizationSlug","tenantOrganizationName"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of a tenant organization that can be deployed to."},"tenantOrganizationSlug":{"type":"string","description":"URL identifier for the tenant organization."},"tenantOrganizationName":{"type":"string","description":"Display name of the tenant organization."}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["deploymentPolicies"]}},"/v2/favorites":{"post":{"summary":"Favorite a document","description":"Favorite a folder or document for a specific user.\n\n  ### Usage notes\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  - Retrieve the **inodeId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and using the `id` included in the response.\n      ","parameters":[],"operationId":"addFavorite","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["memberId","inodeId"],"properties":{"memberId":{"type":"string","description":"Unique identifier of the member."},"inodeId":{"type":"string","description":"Unique identifier of the document or folder."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["favorites"]}},"/v2/favorites/member/{memberId}":{"get":{"summary":"Get favorite documents for a user","description":"Get the favorite documents for a specific user. This endpoint has the same functionality as the [List all favorite documents of a member](https://help.sigmacomputing.com/reference/listfavoriteinodes) endpoint.\n\n  ### Usage notes\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n    ","parameters":[{"name":"memberId","schema":{"type":"string","description":"Unique identifier of the member."},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listFavorites","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["id","urlId","name","type","parentId","parentUrlId","permission","path","badge","isArchived"],"properties":{"id":{"type":"string"},"urlId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"parentId":{"type":"string"},"parentUrlId":{"type":"string"},"permission":{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"]},"path":{"type":"string"},"badge":{"type":["string","null"]},"isArchived":{"type":"boolean"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":["string","null"]},"parentSourceUrlId":{"type":"string","description":"For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.","title":"Parent Source URL ID"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]},"examples":{"Response Example":{"value":{"entries":[{"id":"00000000-0000-0000-0000-000000000000","urlId":"57a96EMo3GVJG73179MV2l","name":"Examples","description":"Examples description","type":"folder","parentId":"00000000-0000-0000-0000-000000000001","parentUrlId":"57a96EMo3GVJG73179MV2G","permission":"edit","path":"My Documents/Examples","badge":"Endorsed","ownerId":"<memberId>","createdBy":"<memberId>","updatedBy":"<memberId>","createdAt":"2022-11-22T22:33:47.323Z","updatedAt":"2022-11-22T22:33:47.323Z","isArchived":false}],"hasMore":false,"total":1,"nextPage":null}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"https://sigma.bi/member-api","description":"Sigma API documentation:"},"tags":["favorites"]}},"/v2/favorites/member/{memberId}/file/{inodeId}":{"delete":{"summary":"Unfavorite a document","description":"Unfavorite a folder or document for a specific user.\n\n  ### Usage notes\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  - Retrieve the **inodeId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and using the **id** included in the response.\n    ","parameters":[{"name":"memberId","schema":{"type":"string","description":"Unique identifier of the member."},"in":"path","required":true},{"name":"inodeId","schema":{"type":"string","description":"Unique identifier of the document or folder."},"in":"path","required":true}],"operationId":"removeFavorite","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["favorites"]}},"/v2/files":{"get":{"summary":"List files","description":"List all documents, such as workbooks and folders, accessible from the parent.\n\n  ### Which files are returned by this endpoint\n\n  The documents and folders accessible through this endpoint match those returned when you search in the Sigma UI. Some documents that you can view in the Sigma UI are not returned by this endpoint.\n\n  - Returned documents and folders are limited to those that you have access to, such as through ownership, a document directly shared with you, a document link shared with you that you have opened, or access inherited through a folder or a workspace. This restriction also applies to users granted the Admin account type.\n  - Newly created files are not returned immediately after creation. Updated files are reflected immediately.\n  - If no `typeFilters` are set, only workbooks, folders, data models, datasets (deprecated), and reports are returned. To return other file types, such as a shortcut (symlink), specify a file type using the `typeFilters` option.\n\n  ### Usage notes\n\n  - Use the **parentId** to specify a folder and return details about the nested files and documents:\n    - Retrieve the ID to use as a **parentId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n    - To use the \"My Documents\" folder as the parent folder, call the [/v2/members/{memberId}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response.\n    - If parentId is not specified, it is assumed to be the root.\n  - Use the available filters to return files that contain a specific keyword in the name, files with specific permissions granted to the user associated with the API credentials, or files of a specific type.\n    ","parameters":[{"name":"name","schema":{"type":"string"},"in":"query"},{"name":"permissionFilter","schema":{"oneOf":[{"type":"string","enum":["view","explore","edit"],"description":"","title":"Workbook Permission"},{"type":"string","enum":["view","explore","organize","edit"],"description":"Choose **organize** for Can Contribute permissions or **edit** for Can Manage permissions.","title":"Folder Permission"}]},"in":"query"},{"name":"typeFilters","schema":{"oneOf":[{"type":"array","items":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"description":"**Note**: Workspaces are not returned as part of the response. To retrieve a workspace, use the **Single Document Type**.","title":"Multiple Document Types"},{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"],"description":"","title":"Single Document Type"}]},"in":"query"},{"name":"page","schema":{"type":"string"},"in":"query"},{"name":"limit","schema":{"type":"number"},"in":"query"},{"name":"parentId","schema":{"type":"string","description":"Parent folder"},"in":"query"},{"name":"directChildFilter","schema":{"type":"boolean"},"in":"query"}],"operationId":"filesList","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["id","urlId","name","type","parentId","parentUrlId","permission","path","badge","isArchived"],"properties":{"id":{"type":"string"},"urlId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"parentId":{"type":"string"},"parentUrlId":{"type":"string"},"permission":{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"]},"path":{"type":"string"},"badge":{"type":["string","null"]},"isArchived":{"type":"boolean"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":["string","null"]},"parentSourceUrlId":{"type":"string","description":"For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.","title":"Parent Source URL ID"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]},"examples":{"Response Example":{"value":{"entries":[{"id":"00000000-0000-0000-0000-000000000000","urlId":"57a96EMo3GVJG73179MV2l","name":"Examples","description":"Examples description","type":"folder","parentId":"00000000-0000-0000-0000-000000000001","parentUrlId":"57a96EMo3GVJG73179MV2G","permission":"edit","path":"My Documents/Examples","badge":"Endorsed","ownerId":"<memberId>","createdBy":"<memberId>","updatedBy":"<memberId>","createdAt":"2022-11-22T22:33:47.323Z","updatedAt":"2022-11-22T22:33:47.323Z","isArchived":false}],"hasMore":false,"total":1,"nextPage":null}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["files"]},"post":{"summary":"Create a file","description":"Create an empty workspace, folder, workbook, or report in Sigma.\n\n  ### Usage notes\n  - Specify a **parentId** for a folder, workbook, or report to place it within another folder. Retrieve the ID to use as a **parentId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n  - Specify an **ownerId** for a folder, workbook, or report to create it on behalf of another user. Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n\n  ### Usage scenarios\n  - **Project onboarding**: Start a new project by creating a workspace and folders to contain the workbooks for the project.\n    ","parameters":[],"operationId":"filesCreate","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["workspace"]},"name":{"type":"string"}},"description":"Workspace to create","title":"Workspace details"},{"allOf":[{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["folder"]},"name":{"type":"string"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":"string"},"parentId":{"type":"string"}}}],"description":"Folder to create","title":"Folder details"},{"allOf":[{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["workbook"]},"name":{"type":"string"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":"string"},"parentId":{"type":"string"},"source":{"type":"object","required":["inodeId","version"],"properties":{"inodeId":{"type":"string"},"version":{"type":"number"}}}}}],"description":"Workbook to create","title":"Workbook details"},{"allOf":[{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["report"]},"name":{"type":"string"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":"string"},"parentId":{"type":"string"}}}],"description":"Report to create","title":"Report details"}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["id","urlId","name","type","parentId","parentUrlId","permission","path","badge","isArchived"],"properties":{"id":{"type":"string"},"urlId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"parentId":{"type":"string"},"parentUrlId":{"type":"string"},"permission":{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"]},"path":{"type":"string"},"badge":{"type":["string","null"]},"isArchived":{"type":"boolean"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":["string","null"]},"parentSourceUrlId":{"type":"string","description":"For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.","title":"Parent Source URL ID"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"examples":{"Response Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","urlId":"57a96EMo3GVJG73179MV2l","name":"Examples","description":"Examples description","type":"folder","parentId":"00000000-0000-0000-0000-000000000001","parentUrlId":"57a96EMo3GVJG73179MV2G","permission":"edit","path":"My Documents/Examples","badge":"Endorsed","ownerId":"<memberId>","createdBy":"<memberId>","updatedBy":"<memberId>","createdAt":"2022-11-22T22:33:47.323Z","updatedAt":"2022-11-22T22:33:47.323Z","isArchived":false}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["files"]}},"/v2/files/{inodeId}":{"get":{"summary":"Get file information","description":"Get information about a specific document or folder, such as a workbook, report, or data model.\n\n  ### Usage notes\n  - Retrieve the **inodeId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and using the `id` included in the response.\n  - Retrieve the **inodeId** for a data model by calling the [/v2/members/{memberId}/files/recents](https://help.sigmacomputing.com/reference/list-recent-inodes) endpoint and using the `id` included in the response.\n    ","parameters":[{"name":"inodeId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"filesGet","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["id","urlId","name","type","parentId","parentUrlId","permission","path","badge","isArchived"],"properties":{"id":{"type":"string"},"urlId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"parentId":{"type":"string"},"parentUrlId":{"type":"string"},"permission":{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"]},"path":{"type":"string"},"badge":{"type":["string","null"]},"isArchived":{"type":"boolean"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":["string","null"]},"parentSourceUrlId":{"type":"string","description":"For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.","title":"Parent Source URL ID"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"examples":{"Response Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","urlId":"57a96EMo3GVJG73179MV2l","name":"Examples","description":"Examples description","type":"folder","parentId":"00000000-0000-0000-0000-000000000001","parentUrlId":"57a96EMo3GVJG73179MV2G","permission":"edit","path":"My Documents/Examples","badge":"Endorsed","ownerId":"<memberId>","createdBy":"<memberId>","updatedBy":"<memberId>","createdAt":"2022-11-22T22:33:47.323Z","updatedAt":"2022-11-22T22:33:47.323Z","isArchived":false}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["files"]},"patch":{"summary":"Update a file","description":"Update a folder or document, such as a workbook, data model, or report.\n\n  ### Usage notes\n  - Retrieve the **inodeId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and using the `id` included in the response.\n  - Specify a **parentId** to place the document within a folder. Retrieve the ID to use as a **parentId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n  - To restore a deleted folder or document, set the **restore** parameter to `true`.\n    ","parameters":[{"name":"inodeId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"filesUpdate","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"ownerId":{"type":"string"},"parentId":{"type":"string","description":"Folder ID to contain the folder or document"},"restore":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["id","urlId","name","type","parentId","parentUrlId","permission","path","badge","isArchived"],"properties":{"id":{"type":"string"},"urlId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"parentId":{"type":"string"},"parentUrlId":{"type":"string"},"permission":{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"]},"path":{"type":"string"},"badge":{"type":["string","null"]},"isArchived":{"type":"boolean"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":["string","null"]},"parentSourceUrlId":{"type":"string","description":"For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.","title":"Parent Source URL ID"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["files"]},"delete":{"summary":"Delete a file","description":"Delete a folder or document, such as a workbook, data model, or report.\n\n  ### Usage notes\n  - Retrieve the **inodeId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and using the `id` included in the response.\n    ","parameters":[{"name":"inodeId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"filesDelete","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["files"]}},"/v2/grants":{"get":{"summary":"List grants","description":"List all grants for a given object.\n\n  ### Usage notes\n\n  You can specify one of the following:\n\n  - A user by userId. Retrieve the **userId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint and using the `memberId` included in the response.\n  - A team by teamId. Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  - A document (such as a workbook, report, data model, or dataset (deprecated)), folder, or workspace by inodeId.\n    - Retrieve the **inodeId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and using the `id` included in the response.\n    - Retrieve the **inodeId** for a data model by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint and using the `dataModelId` included in the response.\n\n  ### Usage scenarios\n  - **Manage inherited permissions**: Identify files and folders that have permissions directly granted to them.\n  - **Review long-lived permissions**: Audit permissions granted more than a year ago and determine if they are still needed.\n    ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"inodeId","schema":{"type":"string"},"in":"query"},{"name":"teamId","schema":{"type":"string"},"in":"query"},{"name":"userId","schema":{"type":"string"},"in":"query"},{"name":"directGrantsOnly","schema":{"type":"boolean"},"in":"query"}],"operationId":"listGrants","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["grantId","inodeId","organizationId","memberId","teamId","permission","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"grantId":{"type":"string","description":"The unique identifier of the grant"},"inodeId":{"type":"string","description":"The unique identifier of the inode"},"organizationId":{"type":"string","description":"The unique identifier of the organization"},"memberId":{"type":["string","null"],"description":"The unique identifier of the member"},"teamId":{"type":["string","null"],"description":"The unique identifier of the team"},"permission":{"oneOf":[{"type":"string","enum":["admin","annotate","update","usage","writeback"],"description":"Valid inode types: table, connection database, and connection schema.","title":"Connection Permission"},{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"],"description":"Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.","title":"Inode Permission"},{"type":"string","enum":["view","edit","apply"],"description":"Valid inode types: version tag.","title":"Version Tag Permission"}],"description":"The permission granted to the member"},"createdBy":{"type":"string","description":"The identifier of the user who created this grant"},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this grant"},"createdAt":{"type":"string","format":"date-time","description":"When the grant was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the grant was last updated"}},"title":"Connection grant response"},{"type":"object","required":["inodeType"],"properties":{"inodeType":{"type":"string","enum":["folder","customFunction","symlink","versionTag","worksheet","block","dashboard","report","table","semanticView","metricView","scope","sql","workbook","template","dataset","datafile","storedProcedure","apiConnector","apiConnectorAuth","mcpConnector","warehouseAgent","agentSkill","tlsProfile","schedule","application","appBranch"]}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["grants"]},"post":{"summary":"Create or update a grant","description":"Create a grant or update an existing grant on a document, folder, or workspace to a user or a team by ID.\n\n  ### Usage notes\n  - This endpoint can only be used to escalate the level of access that a user has to a document. To remove or reduce a user's access to a specific document, call [/v2/grants/{grantId}](https://help.sigmacomputing.com/reference/delete-grant) to delete the existing grant and re-grant the desired level of access.\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  - Retrieve the **inodeId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and using the `id` included in the response.\n  - Retrieve the **inodeId** for a data model by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint and using the `dataModelId` included in the response.\n  - Optionally specify a **tagId** to associate the permission with a specific version tag of a workbook, dataset (deprecated), or database table. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` included in the response.\n    ","parameters":[],"operationId":"createGrant","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["grantee","permission","inodeId"],"properties":{"grantee":{"oneOf":[{"type":"object","required":["memberId"],"properties":{"memberId":{"type":"string"}},"description":"User or member ID","title":"Member"},{"type":"object","required":["teamId"],"properties":{"teamId":{"type":"string"}},"description":"Team ID","title":"Team"}]},"permission":{"oneOf":[{"type":"string","enum":["admin","annotate","update","usage","writeback"],"description":"Valid inode types: table, connection database, and connection schema.","title":"Connection Permission"},{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"],"description":"Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.","title":"Inode Permission"},{"type":"string","enum":["view","edit","apply"],"description":"Valid inode types: version tag.","title":"Version Tag Permission"}]},"inodeId":{"type":"string"}}},{"type":"object","properties":{"tagId":{"type":"string"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["grantId","inodeId","organizationId","memberId","teamId","permission","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"grantId":{"type":"string","description":"The unique identifier of the grant"},"inodeId":{"type":"string","description":"The unique identifier of the inode"},"organizationId":{"type":"string","description":"The unique identifier of the organization"},"memberId":{"type":["string","null"],"description":"The unique identifier of the member"},"teamId":{"type":["string","null"],"description":"The unique identifier of the team"},"permission":{"oneOf":[{"type":"string","enum":["admin","annotate","update","usage","writeback"],"description":"Valid inode types: table, connection database, and connection schema.","title":"Connection Permission"},{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"],"description":"Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.","title":"Inode Permission"},{"type":"string","enum":["view","edit","apply"],"description":"Valid inode types: version tag.","title":"Version Tag Permission"}],"description":"The permission granted to the member"},"createdBy":{"type":"string","description":"The identifier of the user who created this grant"},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this grant"},"createdAt":{"type":"string","format":"date-time","description":"When the grant was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the grant was last updated"}},"title":"Connection grant response"},{"type":"object","required":["inodeType"],"properties":{"inodeType":{"type":"string","enum":["folder","customFunction","symlink","versionTag","worksheet","block","dashboard","report","table","semanticView","metricView","scope","sql","workbook","template","dataset","datafile","storedProcedure","apiConnector","apiConnectorAuth","mcpConnector","warehouseAgent","agentSkill","tlsProfile","schedule","application","appBranch"]}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["grants"]}},"/v2/grants/{grantId}":{"get":{"summary":"Get a grant","description":"Return a grant object by grant ID.\n\n  ### Usage notes\n\n  Depending on the grant object that you want to return details about, you can retrieve the grantId in different ways:\n\n  - For most documents, you can retrieve the **grantId** by calling the [/v2/grants](https://help.sigmacomputing.com/reference/list-grants) endpoint with the **inodeId** for the document. For example, use the **workbookId** as the **inodeId**.\n  - For a dataset (deprecated), you can also retrieve the **grantId** by calling the [/v2/datasets/{datasetId}/grants](https://help.sigmacomputing.com/reference/list-dataset-grants) endpoint.\n  - For a connection path, you can retrieve the **grantId** by calling the [/v2/connections/paths/{connectionPathId}/grants](https://help.sigmacomputing.com/reference/list-connection-path-grants) endpoint.\n    ","parameters":[{"name":"grantId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getGrant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["grantId","inodeId","organizationId","memberId","teamId","permission","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"grantId":{"type":"string","description":"The unique identifier of the grant"},"inodeId":{"type":"string","description":"The unique identifier of the inode"},"organizationId":{"type":"string","description":"The unique identifier of the organization"},"memberId":{"type":["string","null"],"description":"The unique identifier of the member"},"teamId":{"type":["string","null"],"description":"The unique identifier of the team"},"permission":{"oneOf":[{"type":"string","enum":["admin","annotate","update","usage","writeback"],"description":"Valid inode types: table, connection database, and connection schema.","title":"Connection Permission"},{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"],"description":"Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.","title":"Inode Permission"},{"type":"string","enum":["view","edit","apply"],"description":"Valid inode types: version tag.","title":"Version Tag Permission"}],"description":"The permission granted to the member"},"createdBy":{"type":"string","description":"The identifier of the user who created this grant"},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this grant"},"createdAt":{"type":"string","format":"date-time","description":"When the grant was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the grant was last updated"}},"title":"Connection grant response"},{"type":"object","required":["inodeType"],"properties":{"inodeType":{"type":"string","enum":["folder","customFunction","symlink","versionTag","worksheet","block","dashboard","report","table","semanticView","metricView","scope","sql","workbook","template","dataset","datafile","storedProcedure","apiConnector","apiConnectorAuth","mcpConnector","warehouseAgent","agentSkill","tlsProfile","schedule","application","appBranch"]}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["grants"]},"delete":{"summary":"Delete a grant","description":"Delete a grant by grant ID.\n\n  ### Usage notes\n  Depending on the grant object that you want to delete, you can retrieve the grantId in different ways:\n\n  - For most documents, you can retrieve the **grantId** by calling the [/v2/grants](https://help.sigmacomputing.com/reference/list-grants) endpoint with the **inodeId** for the document. For example, use the **workbookId** as the **inodeId**.\n  - For a dataset (deprecated), you can also retrieve the **grantId** by calling the [/v2/datasets/{datasetId}/grants](https://help.sigmacomputing.com/reference/list-dataset-grants) endpoint.\n  - For a connection path, you can retrieve the **grantId** by calling the [/v2/connections/paths/{connectionPathId}/grants](https://help.sigmacomputing.com/reference/list-connection-path-grants) endpoint.\n\n  ### Usage scenarios\n  - **Principle of least privilege**: Revoke unnecessary privileges on a document by removing the grant.\n    ","parameters":[{"name":"grantId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteGrant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["grantId","inodeId","organizationId","memberId","teamId","permission","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"grantId":{"type":"string","description":"The unique identifier of the grant"},"inodeId":{"type":"string","description":"The unique identifier of the inode"},"organizationId":{"type":"string","description":"The unique identifier of the organization"},"memberId":{"type":["string","null"],"description":"The unique identifier of the member"},"teamId":{"type":["string","null"],"description":"The unique identifier of the team"},"permission":{"oneOf":[{"type":"string","enum":["admin","annotate","update","usage","writeback"],"description":"Valid inode types: table, connection database, and connection schema.","title":"Connection Permission"},{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"],"description":"Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.","title":"Inode Permission"},{"type":"string","enum":["view","edit","apply"],"description":"Valid inode types: version tag.","title":"Version Tag Permission"}],"description":"The permission granted to the member"},"createdBy":{"type":"string","description":"The identifier of the user who created this grant"},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this grant"},"createdAt":{"type":"string","format":"date-time","description":"When the grant was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the grant was last updated"}},"title":"Connection grant response"},{"type":"object","required":["inodeType"],"properties":{"inodeType":{"type":"string","enum":["folder","customFunction","symlink","versionTag","worksheet","block","dashboard","report","table","semanticView","metricView","scope","sql","workbook","template","dataset","datafile","storedProcedure","apiConnector","apiConnectorAuth","mcpConnector","warehouseAgent","agentSkill","tlsProfile","schedule","application","appBranch"]}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["grants"]}},"/v2/members":{"get":{"summary":"List members","description":"\n  **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request.\n\n  List all users in Sigma.\n\n  ### Usage notes\n  - Filter your results using the `email` query parameter.\n  - If using `email` to filter by email address, you must URL encode the \"@\" character as `%40`.\n  ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"email","schema":{"type":"string","description":"Filter by email address. You must URL encode the \"@\" character as `%40`."},"in":"query"},{"name":"includeArchived","schema":{"type":"boolean"},"in":"query"},{"name":"includeInactive","schema":{"type":"boolean"},"in":"query"}],"operationId":"listMembers","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"allOf":[{"type":"object","required":["organizationId","memberId","memberType","firstName","lastName","email","profileImgUrl","createdBy","updatedBy","createdAt","updatedAt","homeFolderId","userKind"],"properties":{"organizationId":{"type":"string"},"memberId":{"type":"string"},"memberType":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"profileImgUrl":{"type":["string","null"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"homeFolderId":{"type":"string","description":"ID of the My Documents folder for the user"},"userKind":{"type":"string"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether a user is deactivated in Sigma."},"isInactive":{"type":"boolean","description":"Whether a user is archived by SCIM."}}}]}},{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["organizationId","memberId","memberType","firstName","lastName","email","profileImgUrl","createdBy","updatedBy","createdAt","updatedAt","homeFolderId","userKind"],"properties":{"organizationId":{"type":"string"},"memberId":{"type":"string"},"memberType":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"profileImgUrl":{"type":["string","null"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"homeFolderId":{"type":"string","description":"ID of the My Documents folder for the user"},"userKind":{"type":"string"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether a user is deactivated in Sigma."},"isInactive":{"type":"boolean","description":"Whether a user is archived by SCIM."}}}]}},"nextPage":{"type":["string","null"]}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]},"post":{"summary":"Create a member","description":"Create a user.\n\n  ### Usage notes\n  - Creating a user with this endpoint sends an email invitation to the user. Embed users are not sent email invitations.\n  - Review the account types returned by the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint to understand the format of the **memberType** string.\n  - If **memberType** is omitted, the organization's Invitation default account type (configured in Admin > Account types) is used. If no Invitation default is configured, a built-in default account type is used.\n  - Retrieve the **teamId**(s) by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoints.\n    ","parameters":[{"name":"sendInvite","schema":{"type":"boolean","description":"Whether to send an email invitation for non-embed users. If not included, an email is sent","title":"Send Invite"},"in":"query"}],"operationId":"createMember","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["email","firstName","lastName"],"properties":{"email":{"type":"string","format":"email"},"firstName":{"type":"string"},"lastName":{"type":"string"}}},{"type":"object","properties":{"memberType":{"type":"string","description":"Account type"},"isGuest":{"type":"boolean"},"userKind":{"type":"string","enum":["internal","guest","embed"]},"addToTeams":{"type":"array","items":{"allOf":[{"type":"object","required":["teamId"],"properties":{"teamId":{"type":"string"}}},{"type":"object","properties":{"isTeamAdmin":{"type":"boolean"}},"description":"Whether to set the user as an admin for this team."}]},"description":"Add user to one or more teams."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["organizationId","memberId","memberType","firstName","lastName","email","profileImgUrl","createdBy","updatedBy","createdAt","updatedAt","homeFolderId","userKind"],"properties":{"organizationId":{"type":"string"},"memberId":{"type":"string"},"memberType":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"profileImgUrl":{"type":["string","null"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"homeFolderId":{"type":"string","description":"ID of the My Documents folder for the user"},"userKind":{"type":"string"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether a user is deactivated in Sigma."},"isInactive":{"type":"boolean","description":"Whether a user is archived by SCIM."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]}},"/v2/members/{memberId}":{"get":{"summary":"Get member","description":"Returns a specific user by member ID.\n\n### Usage notes\n- Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  ","parameters":[{"name":"memberId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getMember","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["organizationId","memberId","memberType","firstName","lastName","email","profileImgUrl","createdBy","updatedBy","createdAt","updatedAt","homeFolderId","userKind"],"properties":{"organizationId":{"type":"string"},"memberId":{"type":"string"},"memberType":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"profileImgUrl":{"type":["string","null"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"homeFolderId":{"type":"string","description":"ID of the My Documents folder for the user"},"userKind":{"type":"string"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether a user is deactivated in Sigma."},"isInactive":{"type":"boolean","description":"Whether a user is archived by SCIM."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]},"patch":{"summary":"Update member","description":"Update a specific user by memberId.\n\n  ### Usage notes\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  - Review the account types returned by the same endpoint to understand the format of the **memberType** string.\n  - To deactivate a user and reassign their documents to a specific user, set  `newOwnerId`to the user ID of the desired document owner, and `isArchived` to `True`. For more details, see [Deactivate a user](/docs/deactivate-users).\n    ","parameters":[{"name":"memberId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateMember","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"memberType":{"type":"string","description":"Account type"},"firstName":{"type":"string"},"lastName":{"type":"string"},"profileImgUrl":{"type":["string","null"]},"email":{"type":"string"},"isArchived":{"type":"boolean","description":"Whether to deactivate a user in Sigma."},"isInactive":{"type":"boolean","description":"Whether to archive a user with SCIM."},"userKind":{"type":"string","enum":["internal","guest","embed"]},"newOwnerId":{"type":"string"},"archiveDocuments":{"type":"boolean","description":"Archive a user's documents instead of transferring them. Can only be used if either `isArchived` or `isInactive` is set to `true`. Also archives scheduled exports."},"archiveScheduledExports":{"type":"boolean","description":"Archive a user's scheduled exports instead of transferring them. Can only be used if either `isArchived` or `isInactive` is set to `true`"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["organizationId","memberId","memberType","firstName","lastName","email","profileImgUrl","createdBy","updatedBy","createdAt","updatedAt","homeFolderId","userKind"],"properties":{"organizationId":{"type":"string"},"memberId":{"type":"string"},"memberType":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"profileImgUrl":{"type":["string","null"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"homeFolderId":{"type":"string","description":"ID of the My Documents folder for the user"},"userKind":{"type":"string"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether a user is deactivated in Sigma."},"isInactive":{"type":"boolean","description":"Whether a user is archived by SCIM."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]},"delete":{"summary":"Deactivate member","description":"Deactivate a specific user by memberId. Users cannot be fully deleted, only deactivated. The deactivated user's documents are reassigned to the user associated with the API client credentials. For more information, see [Deactivate users](/docs/deactivate-users).\n\n### Usage notes\n- Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n- The user is directly marked **archived** by this API. See [Deactivate users](/docs/deactivate-users) for more details on deactivation.\n\n### Usage scenarios\n- **User offboarding**: Manage your user base by efficiently offboarding users after they leave your organization.\n\n### Best practices\n- **Confirm memberId**: Before deactivating a user, make sure the memberId is correct.\n- Do **not** use this for members provisioned through SCIM.\n  ","parameters":[{"name":"memberId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteMember","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]}},"/v2/members/{memberId}/files":{"get":{"summary":"List member files","description":"List all documents and folders accessible to a specific user.\n\n  ### Usage notes\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  - Filter to documents with specific permissions granted on them, or to specific types of documents like workbooks, workbook templates, data models, datasets (deprecated), reports, workspaces, database tables, and others.\n    ","parameters":[{"name":"memberId","schema":{"type":"string"},"in":"path","required":true},{"name":"name","schema":{"type":"string"},"in":"query"},{"name":"permissionFilter","schema":{"oneOf":[{"type":"string","enum":["view","explore","edit"],"description":"","title":"Workbook Permission"},{"type":"string","enum":["view","explore","organize","edit"],"description":"Choose **organize** for Can Contribute permissions or **edit** for Can Manage permissions.","title":"Folder Permission"}]},"in":"query"},{"name":"typeFilters","schema":{"oneOf":[{"type":"array","items":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"description":"**Note**: Workspaces are not returned as part of the response. To retrieve a workspace, use the **Single Document Type**.","title":"Multiple Document Types"},{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"],"description":"","title":"Single Document Type"}]},"in":"query"},{"name":"page","schema":{"type":"string"},"in":"query"},{"name":"limit","schema":{"type":"number"},"in":"query"},{"name":"parentId","schema":{"type":"string","description":"Parent folder"},"in":"query"},{"name":"directChildFilter","schema":{"type":"boolean"},"in":"query"}],"operationId":"listAccessibleInodes","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["id","urlId","name","type","parentId","parentUrlId","permission","path","badge","isArchived"],"properties":{"id":{"type":"string"},"urlId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"parentId":{"type":"string"},"parentUrlId":{"type":"string"},"permission":{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"]},"path":{"type":"string"},"badge":{"type":["string","null"]},"isArchived":{"type":"boolean"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":["string","null"]},"parentSourceUrlId":{"type":"string","description":"For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.","title":"Parent Source URL ID"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]},"examples":{"Response Example":{"value":{"entries":[{"id":"00000000-0000-0000-0000-000000000000","urlId":"57a96EMo3GVJG73179MV2l","name":"Examples","description":"Examples description","type":"folder","parentId":"00000000-0000-0000-0000-000000000001","parentUrlId":"57a96EMo3GVJG73179MV2G","permission":"edit","path":"My Documents/Examples","badge":"Endorsed","ownerId":"<memberId>","createdBy":"<memberId>","updatedBy":"<memberId>","createdAt":"2022-11-22T22:33:47.323Z","updatedAt":"2022-11-22T22:33:47.323Z","isArchived":false}],"hasMore":false,"total":1,"nextPage":null}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]}},"/v2/members/{memberId}/files/favorites":{"get":{"summary":"List all favorite documents of a member","description":"List the favorite documents for a specific user.\n\n  ### Usage notes\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n    ","parameters":[{"name":"memberId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listFavoriteInodes","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["id","urlId","name","type","parentId","parentUrlId","permission","path","badge","isArchived"],"properties":{"id":{"type":"string"},"urlId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"parentId":{"type":"string"},"parentUrlId":{"type":"string"},"permission":{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"]},"path":{"type":"string"},"badge":{"type":["string","null"]},"isArchived":{"type":"boolean"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":["string","null"]},"parentSourceUrlId":{"type":"string","description":"For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.","title":"Parent Source URL ID"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]},"examples":{"Response Example":{"value":{"entries":[{"id":"00000000-0000-0000-0000-000000000000","urlId":"57a96EMo3GVJG73179MV2l","name":"Examples","description":"Examples description","type":"folder","parentId":"00000000-0000-0000-0000-000000000001","parentUrlId":"57a96EMo3GVJG73179MV2G","permission":"edit","path":"My Documents/Examples","badge":"Endorsed","ownerId":"<memberId>","createdBy":"<memberId>","updatedBy":"<memberId>","createdAt":"2022-11-22T22:33:47.323Z","updatedAt":"2022-11-22T22:33:47.323Z","isArchived":false}],"hasMore":false,"total":1,"nextPage":null}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]}},"/v2/members/{memberId}/files/recents":{"get":{"summary":"List recent files for a member","description":"List all recent documents and folders accessible to a specific user. By default, ignores explorations in the returned list.\n\n  ### Usage notes\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n    ","parameters":[{"name":"memberId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"includeExplorations","schema":{"type":"string","enum":["true","false"],"description":"Include explorations in the response.","title":"Include Explorations"},"in":"query"}],"operationId":"listRecentInodes","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"allOf":[{"type":"object","required":["id","urlId","name","type","parentId","parentUrlId","permission","path","badge","isArchived"],"properties":{"id":{"type":"string"},"urlId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["workspace","folder","workbook","dataset","data-model","sql","worksheet","dashboard","template","table","symlink","report"]},"parentId":{"type":"string"},"parentUrlId":{"type":"string"},"permission":{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"]},"path":{"type":"string"},"badge":{"type":["string","null"]},"isArchived":{"type":"boolean"}}},{"type":"object","properties":{"description":{"type":"string"},"ownerId":{"type":["string","null"]},"parentSourceUrlId":{"type":"string","description":"For a document deployed to a tenant organization, the `urlId` of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.","title":"Parent Source URL ID"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},{"type":"object","properties":{"lastInteractionAt":{"type":"string","format":"date-time"}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]},"examples":{"Response Example":{"value":{"entries":[{"id":"00000000-0000-0000-0000-000000000000","urlId":"57a96EMo3GVJG73179MV2l","name":"Examples","description":"Examples description","type":"folder","parentId":"00000000-0000-0000-0000-000000000001","parentUrlId":"57a96EMo3GVJG73179MV2G","permission":"edit","path":"My Documents/Examples","badge":"Endorsed","ownerId":"<memberId>","createdBy":"<memberId>","updatedBy":"<memberId>","createdAt":"2022-11-22T22:33:47.323Z","updatedAt":"2022-11-22T22:33:47.323Z","isArchived":false,"lastInteractionAt":"2023-11-22T22:33:47.323Z"}],"hasMore":false,"total":1,"nextPage":null}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]}},"/v2/members/{memberId}/revoke":{"post":{"summary":"Revoke a user's OAuth tokens","description":"Revoke a user's OAuth refresh tokens used for OIDC single sign-on and warehouse connections, so Sigma can no longer issue new access tokens on the user's behalf.\n\nAfter making a request to this endpoint, refresh tokens are revoked immediately. However, a user's existing session is not interrupted. Already-issued access tokens lapse at their normal TTL.\n\n### Usage notes\n- Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n- You must use API credentials owned by a user assigned the Admin account type.\n  ","parameters":[{"name":"memberId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"revokeMemberTokens","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["memberId","results"],"properties":{"memberId":{"type":"string","description":"Unique identifier of the user whose tokens were revoked."},"results":{"type":"object","required":["oauth"],"properties":{"oauth":{"type":"object","required":["tokensRevoked"],"properties":{"tokensRevoked":{"type":"number","description":"Number of refresh tokens revoked."}}}},"description":"Revocation result per token type."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]}},"/v2/members/{memberId}/schedules":{"get":{"summary":"List scheduled exports for a user","description":"Retrieve all scheduled exports owned by a specific user across all workbooks and reports that they have access to.\n\n### Usage notes\n- Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n- To perform this operation for another user, you must use API credentials owned by a user assigned the Admin account type.\n- Non-admin users can only retrieve their own schedules.\n- To retrieve scheduled exports for a specific workbook, call the [/v2/workbooks/{workbookId}/schedules](https://help.sigmacomputing.com/reference/list-workbook-schedules) endpoint.\n\n### Usage scenarios\n- **User dashboard:** Display all scheduled exports owned by a user in a centralized dashboard.\n- **Scheduled export management:** Allow users to view and manage all their scheduled exports across different workbooks and reports.\n- **Audit and compliance:** Review all scheduled exports created by a specific user for governance purposes.\n- **Cross-user management:** Admins can view and manage schedules on behalf of other users.\n  ","parameters":[{"name":"memberId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listMemberSchedules","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["scheduledNotificationId","workbookId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["EXCEL"]}}},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}}},{"type":"object","properties":{"pixelWidth":{"type":["number","null"]},"pixelHeight":{"type":["number","null"]}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"chartId":{"type":"string"},"workbookExportSource":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["element"]},"elementId":{"type":"string"}},"description":"Export one element","title":"One element"},{"type":"object","required":["type","pageId"],"properties":{"type":{"type":"string","enum":["page"]},"pageId":{"type":"string"}},"description":"Export one page","title":"One page"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["element"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple elements","title":"Multiple elements"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["page"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple pages","title":"Multiple pages"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"Export all pages and elements in a workbook","title":"Entire workbook"}]}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"dashboardSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"workbookVariant":{"type":"object","properties":{"tagId":{"type":"string"},"exploreKey":{"type":"string"},"bookmarkId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}},"formatting":{"type":["object","null"],"properties":{"pivotHeaderStyle":{"type":["string","null"],"enum":["merged","repeated"]}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},{"allOf":[{"type":"object","required":["scheduledNotificationId","reportId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"workbookExportSource":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["report"]}}}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"reportSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"reportVariant":{"type":"object","properties":{"tagId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]}},"/v2/members/{memberId}/teams":{"get":{"summary":"List teams for a member","description":"Retrieve a list of teams for a specific user.\n\n### Usage notes\n- Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n  ","parameters":[{"name":"memberId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listMemberTeams","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["teamId","createdBy","updatedBy","createdAt","updatedAt","name","description","visibility"],"properties":{"teamId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":["string","null"]},"visibility":{"type":["string","null"],"enum":["public","private"]}}},{"type":"object","properties":{"isArchived":{"type":"boolean"}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]}},"/v2/organizations/settings/aiConfigs":{"post":{"summary":"Configure the organization's AI provider","description":"Configure the AI provider for the organization associated with the API credentials. Choose one provider for LLM interactions, and optionally a separate provider for embeddings.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Providers differ in which models and regions they support. Review [Supported AI models](https://help.sigmacomputing.com/docs/supported-ai-models) and [Set up an AI provider](https://help.sigmacomputing.com/docs/configure-ai-features-for-your-organization#set-up-an-ai-provider) first.\n- Retrieve the **connectionId** by calling the [/v2/connections](/reference/list-connections) endpoint.\n- `embeddedModel` is optional for warehouse providers, OpenAI, Gemini, and Bedrock. If you omit it, the embedding model for the LLM provider is used. Required for Anthropic and Azure OpenAI.\n\n### Usage scenarios\n- **Automated organization setup:** Configure the AI provider as part of onboarding or infrastructure-as-code, rather than clicking through the administration portal.\n- **Sigma Tenants:** Set the AI provider for each tenant organization programmatically, using impersonation to target a specific tenant.","parameters":[],"operationId":"createAiConfig","requestBody":{"description":"The AI provider to configure for the organization.","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["snowflake"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}}},{"type":"object","properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModel"}}}],"description":"","title":"Snowflake"},{"allOf":[{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["bigquery"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}}},{"type":"object","properties":{"region":{"type":"string","description":"For a BigQuery connection, Vertex AI location for the project. Defaults to `us-central1`."},"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModel"}}}],"description":"","title":"BigQuery"},{"allOf":[{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["databricks"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}}},{"type":"object","properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModel"}}}],"description":"","title":"Databricks"},{"allOf":[{"type":"object","required":["provider","apiKey"],"properties":{"provider":{"type":"string","enum":["openAI"],"description":""},"apiKey":{"type":"string","description":"OpenAI API key."}}},{"type":"object","properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModel"}}}],"description":"","title":"OpenAI"},{"allOf":[{"type":"object","required":["provider","apiKey"],"properties":{"provider":{"type":"string","enum":["gemini"],"description":""},"apiKey":{"type":"string","description":"Gemini API key."}}},{"type":"object","properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModel"}}}],"description":"","title":"Gemini"},{"allOf":[{"type":"object","required":["provider","apiKey"],"properties":{"provider":{"type":"string","enum":["anthropic"],"description":""},"apiKey":{"type":"string","description":"Anthropic API key."}}},{"type":"object","required":["embeddedModel"],"properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModel"}}}],"description":"","title":"Anthropic"},{"allOf":[{"type":"object","required":["provider","iamRoleArn","awsRegion"],"properties":{"provider":{"type":"string","enum":["bedrock"],"description":""},"iamRoleArn":{"type":"string","description":"ARN of the IAM role for Sigma to assume."},"awsRegion":{"type":"string","description":"AWS region of the Bedrock deployment."}}},{"type":"object","properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModel"}}}],"description":"","title":"Amazon Bedrock"},{"allOf":[{"type":"object","required":["provider","openAIDeployment"],"properties":{"provider":{"type":"string","enum":["azureOpenAI"],"description":""},"openAIDeployment":{"type":"object","required":["deploymentId","endpointURL","apiKey"],"properties":{"deploymentId":{"type":"string","description":"Azure OpenAI deployment ID."},"endpointURL":{"type":"string","description":"Azure OpenAI endpoint URL."},"apiKey":{"type":"string","description":"Azure OpenAI API key."}},"description":"The Azure OpenAI deployment to use for the LLM provider."}}},{"type":"object","required":["embeddedModel"],"properties":{"embeddedModel":{"oneOf":[{"$ref":"#/components/schemas/AiSnowflakeEmbeddedModel"},{"$ref":"#/components/schemas/AiBigQueryEmbeddedModel"},{"$ref":"#/components/schemas/AiDatabricksEmbeddedModel"},{"$ref":"#/components/schemas/AiOpenAiEmbeddedModel"},{"$ref":"#/components/schemas/AiGeminiEmbeddedModel"},{"$ref":"#/components/schemas/AiAzureEmbeddedModel"}],"description":"The provider to use for embeddings. Required for Azure OpenAI, which can use its own embeddings deployment or a different provider."}}}],"description":"","title":"Azure OpenAI"}],"description":"The AI provider to configure for the organization."}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["snowflake","bigquery","databricks"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}}},{"type":"object","properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModelRes"}}}],"description":"","title":"Warehouse"},{"allOf":[{"type":"object","required":["provider"],"properties":{"provider":{"type":"string","enum":["openAI"],"description":""}}},{"type":"object","properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModelRes"}}}],"description":"","title":"OpenAI"},{"allOf":[{"type":"object","required":["provider"],"properties":{"provider":{"type":"string","enum":["gemini"],"description":""}}},{"type":"object","properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModelRes"}}}],"description":"","title":"Gemini"},{"allOf":[{"type":"object","required":["provider"],"properties":{"provider":{"type":"string","enum":["anthropic"],"description":""}}},{"type":"object","required":["embeddedModel"],"properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModelRes"}}}],"description":"","title":"Anthropic"},{"allOf":[{"type":"object","required":["provider","iamRoleArn","awsRegion"],"properties":{"provider":{"type":"string","enum":["bedrock"],"description":""},"iamRoleArn":{"type":"string","description":"ARN of the IAM role for Sigma to assume."},"awsRegion":{"type":"string","description":"AWS region of the Bedrock deployment."}}},{"type":"object","properties":{"embeddedModel":{"$ref":"#/components/schemas/AiEmbeddedModelRes"}}},{"type":"object","required":["awsTrustExternalId"],"properties":{"awsTrustExternalId":{"type":"string","description":"External ID to add to your IAM role's trust policy to complete Bedrock setup. Returned only by this request."}}}],"description":"","title":"Amazon Bedrock"},{"type":"object","required":["provider","openAIDeployment","embeddedModel"],"properties":{"provider":{"type":"string","enum":["azureOpenAI"],"description":""},"openAIDeployment":{"type":"object","required":["deploymentId","endpointURL"],"properties":{"deploymentId":{"type":"string","description":"Azure OpenAI deployment ID."},"endpointURL":{"type":"string","description":"Azure OpenAI endpoint URL."}}},"embeddedModel":{"oneOf":[{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["snowflake"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}},"description":"","title":"Snowflake"},{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["bigquery"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}},"description":"","title":"BigQuery"},{"type":"object","required":["provider","connectionId"],"properties":{"provider":{"type":"string","enum":["databricks"],"description":""},"connectionId":{"type":"string","description":"ID of the connection to use as an AI provider."}},"description":"","title":"Databricks"},{"type":"object","required":["provider"],"properties":{"provider":{"type":"string","enum":["openAI"],"description":""}},"description":"","title":"OpenAI"},{"type":"object","required":["provider"],"properties":{"provider":{"type":"string","enum":["gemini"],"description":""}},"description":"","title":"Gemini"},{"type":"object","required":["provider","deploymentId","endpointURL"],"properties":{"provider":{"type":"string","enum":["azureOpenAI"],"description":""},"deploymentId":{"type":"string","description":"Azure OpenAI deployment ID."},"endpointURL":{"type":"string","description":"Azure OpenAI endpoint URL."}},"description":"","title":"Azure OpenAI"}],"description":"The configured embeddings provider. API keys are never included in the response."}},"description":"","title":"Azure OpenAI"}],"description":""}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]}},"/v2/organizations/settings/auditLogging":{"get":{"summary":"Get the audit logging setting for an organization","description":"Check whether audit logging is enabled for the organization.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update this setting for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"getAuditLoggingSetting","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["enabled","enable_in_progress","disabled","disable_in_progress"],"description":"Current state of audit logging for the organization. `enable_in_progress` and `disable_in_progress` mean a background task is still running."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]},"patch":{"summary":"Enable or disable audit logging for an organization","description":"Enable or disable audit logging for the organization.\nEnabling provisions a warehouse user and an audit log connection. Disabling deletes the organization's audit log storage integrations\nalong with any scheduled exports attached to them, archives the connection,\nand deletes the warehouse user. \n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update this setting for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"updateAuditLoggingSetting","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether audit logging should be enabled for the organization."}}}}}},"responses":{"202":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["enabled","enable_in_progress","disabled","disable_in_progress"],"description":"Current state of audit logging for the organization. `enable_in_progress` and `disable_in_progress` mean a background task is still running."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]}},"/v2/organizations/settings/bulkCopy":{"get":{"summary":"Get the bulk copy setting for an organization","description":"Check whether members of the organization can bulk copy data from tables.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"getBulkCopySetting","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the setting is enabled for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]},"patch":{"summary":"Update the bulk copy setting for an organization","description":"Set whether members of the organization can bulk copy data from tables.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"updateBulkCopySetting","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the setting is enabled for the organization."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the setting is enabled for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]}},"/v2/organizations/settings/comments":{"get":{"summary":"Get the comment settings for an organization","description":"Retrieve the organization's commenting and image annotation settings. \n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update these settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"getCommentsSettings","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled","allowAnnotations","annotationRetentionDays"],"properties":{"enabled":{"type":"boolean","description":"Whether users in the organization can comment on documents."},"allowAnnotations":{"type":"boolean","description":"Whether users can capture images and annotate them in comments. Can only set if commenting is enabled."},"annotationRetentionDays":{"type":"number","description":"How long annotation images are kept, in days. Must be between 1 and 730 (two years)."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]},"patch":{"summary":"Update the comment settings for an organization","description":"Update the comment and image annotation settings for an organization.\n\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update these settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"updateCommentsSettings","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether users in the organization can comment on documents."},"allowAnnotations":{"type":"boolean","description":"Whether users can capture images and annotate them in comments. Can only set if commenting is enabled."},"annotationRetentionDays":{"type":"number","description":"How long annotation images are kept, in days. Must be between 1 and 730 (two years)."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled","allowAnnotations","annotationRetentionDays"],"properties":{"enabled":{"type":"boolean","description":"Whether users in the organization can comment on documents."},"allowAnnotations":{"type":"boolean","description":"Whether users can capture images and annotate them in comments. Can only set if commenting is enabled."},"annotationRetentionDays":{"type":"number","description":"How long annotation images are kept, in days. Must be between 1 and 730 (two years)."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]}},"/v2/organizations/settings/csvUpload":{"get":{"summary":"Get the CSV upload settings for an organization","description":"Check the organization's CSV upload configuration.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update these settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"getCsvUploadSettings","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled","useInternalStages","useStorageIntegration","increaseUploadLimit"],"properties":{"enabled":{"type":"boolean","description":"Whether CSV file upload is enabled for the organization."},"useInternalStages":{"type":"boolean","description":"Whether CSV uploads use Snowflake internal stages. Requires the organization to have an active Snowflake connection."},"useStorageIntegration":{"type":"boolean","description":"Whether CSV uploads use the organization's external storage integration instead of Sigma-managed storage."},"increaseUploadLimit":{"type":"boolean","description":"Whether the CSV upload size limit is increased for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]},"patch":{"summary":"Update the CSV upload settings for an organization","description":"Update the organization's CSV upload configuration.\n\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update these settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"updateCsvUploadSettings","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether CSV file upload is enabled for the organization."},"useInternalStages":{"type":"boolean","description":"Whether CSV uploads use Snowflake internal stages. Requires the organization to have an active Snowflake connection."},"useStorageIntegration":{"type":"boolean","description":"Whether CSV uploads use the organization's external storage integration instead of Sigma-managed storage."},"increaseUploadLimit":{"type":"boolean","description":"Whether the CSV upload size limit is increased for the organization."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled","useInternalStages","useStorageIntegration","increaseUploadLimit"],"properties":{"enabled":{"type":"boolean","description":"Whether CSV file upload is enabled for the organization."},"useInternalStages":{"type":"boolean","description":"Whether CSV uploads use Snowflake internal stages. Requires the organization to have an active Snowflake connection."},"useStorageIntegration":{"type":"boolean","description":"Whether CSV uploads use the organization's external storage integration instead of Sigma-managed storage."},"increaseUploadLimit":{"type":"boolean","description":"Whether the CSV upload size limit is increased for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]}},"/v2/organizations/settings/licenseUpgradeRequests":{"get":{"summary":"Get the license upgrade request setting for an organization","description":"Check whether members of the organization can request a license upgrade.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"getLicenseUpgradeRequestsSetting","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the setting is enabled for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]},"patch":{"summary":"Update the license upgrade request setting for an organization","description":"Set whether members of the organization can request a license upgrade.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"updateLicenseUpgradeRequestsSetting","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the setting is enabled for the organization."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the setting is enabled for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]}},"/v2/organizations/settings/publicEmbeds":{"get":{"summary":"Get the public embeds setting for an organization","description":"Check whether the organization allows workbooks to be embedded publicly.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"getPublicEmbedsSetting","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the setting is enabled for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]},"patch":{"summary":"Update the public embeds setting for an organization","description":"Set whether the organization allows workbooks to be embedded publicly.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"updatePublicEmbedsSetting","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the setting is enabled for the organization."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether the setting is enabled for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]}},"/v2/organizations/settings/sampleConnections":{"get":{"summary":"Get the sample connection settings for an organization","description":"Check whether the sample connections are enabled for the organization. \n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update these settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"getSampleConnectionSettings","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enableSnowflake","enableDatabricks"],"properties":{"enableSnowflake":{"type":"boolean","description":"Enable or disable the Snowflake sample connection if it exists for the organization."},"enableDatabricks":{"type":"boolean","description":"Enable or disable the Databricks sample connection if it exists for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]},"patch":{"summary":"Update the sample connection settings for an organization","description":"Enable or disable the sample connections for the organization.\n\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update these settings for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"updateSampleConnectionSettings","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"enableSnowflake":{"type":"boolean","description":"Enable or disable the Snowflake sample connection if it exists for the organization."},"enableDatabricks":{"type":"boolean","description":"Enable or disable the Databricks sample connection if it exists for the organization."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["enableSnowflake","enableDatabricks"],"properties":{"enableSnowflake":{"type":"boolean","description":"Enable or disable the Snowflake sample connection if it exists for the organization."},"enableDatabricks":{"type":"boolean","description":"Enable or disable the Databricks sample connection if it exists for the organization."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]}},"/v2/organizations/settings/timezone":{"get":{"summary":"Get the timezone setting for an organization","description":"Check the IANA timezone configured for the organization.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update this setting for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"getTimezoneSetting","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["timezone"],"properties":{"timezone":{"type":"string","description":"IANA timezone identifier for the organization (e.g. \"America/New_York\")."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]},"patch":{"summary":"Update the timezone setting for an organization","description":"Set the IANA timezone for the organization.\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- To read or update this setting for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token.","parameters":[],"operationId":"updateTimezoneSetting","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["timezone"],"properties":{"timezone":{"type":"string","description":"IANA timezone identifier for the organization (e.g. \"America/New_York\")."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["timezone"],"properties":{"timezone":{"type":"string","description":"IANA timezone identifier for the organization (e.g. \"America/New_York\")."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["organizations"]}},"/v2/plugins":{"get":{"summary":"List plugins","description":"List plugins owned by the current organization.","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 100.","title":"Page size"},"in":"query"}],"operationId":"listCustomPlugins","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["pluginId","name","description","url","devUrl","type"],"properties":{"pluginId":{"type":"string","description":"Unique identifier (UUID) of the plugin."},"name":{"type":"string","description":"Display name of the plugin."},"description":{"type":["string","null"],"description":"Description of the plugin."},"url":{"type":"string","description":"Production URL where the plugin is hosted. Sigma loads the plugin from this URL when it is added to a workbook. An empty string indicates that no production URL has been set for the plugin yet."},"devUrl":{"type":["string","null"],"description":"Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode."},"type":{"type":"string","enum":["element"]}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["plugins"]},"post":{"summary":"Create a plugin","description":"Register a new plugin in the organization. If `url` is omitted, the plugin is created with an empty production URL, and Sigma cannot load the plugin in workbooks until one is set.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type or an account type with the **Manage plugins** permission enabled.","parameters":[],"operationId":"createCustomPlugin","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Display name of the plugin."}}},{"type":"object","properties":{"description":{"type":["string","null"],"description":"Description of the plugin."},"devUrl":{"type":["string","null"],"description":"Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode. Defaults to `http://localhost:5173` if omitted."},"url":{"type":"string","description":"Production URL where the plugin is hosted. Sigma loads the plugin from this URL when it is added to a workbook. If omitted, the plugin is created with an empty URL."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["pluginId","name","description","url","devUrl","type"],"properties":{"pluginId":{"type":"string","description":"Unique identifier (UUID) of the plugin."},"name":{"type":"string","description":"Display name of the plugin."},"description":{"type":["string","null"],"description":"Description of the plugin."},"url":{"type":"string","description":"Production URL where the plugin is hosted. Sigma loads the plugin from this URL when it is added to a workbook. An empty string indicates that no production URL has been set for the plugin yet."},"devUrl":{"type":["string","null"],"description":"Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode."},"type":{"type":"string","enum":["element"]}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["plugins"]}},"/v2/plugins/{pluginId}":{"get":{"summary":"Get a plugin","description":"Get the metadata for a plugin by its ID.\n\n### Usage notes\n- Retrieve the **pluginId** by calling the [/v2/plugins](/reference/list-custom-plugins) endpoint.","parameters":[{"name":"pluginId","schema":{"type":"string","description":"Unique identifier (UUID) of the plugin."},"in":"path","required":true}],"operationId":"getCustomPlugin","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["pluginId","name","description","url","devUrl","type"],"properties":{"pluginId":{"type":"string","description":"Unique identifier (UUID) of the plugin."},"name":{"type":"string","description":"Display name of the plugin."},"description":{"type":["string","null"],"description":"Description of the plugin."},"url":{"type":"string","description":"Production URL where the plugin is hosted. Sigma loads the plugin from this URL when it is added to a workbook. An empty string indicates that no production URL has been set for the plugin yet."},"devUrl":{"type":["string","null"],"description":"Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode."},"type":{"type":"string","enum":["element"]}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["plugins"]},"patch":{"summary":"Update a plugin","description":"Update metadata fields on an existing plugin. Only fields included in the request are changed. The `url` field cannot be updated by this endpoint.\n\n### Usage notes\n- Retrieve the **pluginId** by calling the [/v2/plugins](/reference/list-custom-plugins) endpoint.\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type or an account type with the **Manage plugins** permission enabled.","parameters":[{"name":"pluginId","schema":{"type":"string","description":"Unique identifier (UUID) of the plugin."},"in":"path","required":true}],"operationId":"updateCustomPlugin","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the plugin."},"description":{"type":["string","null"],"description":"Description of the plugin."},"devUrl":{"type":["string","null"],"description":"Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["pluginId","name","description","url","devUrl","type"],"properties":{"pluginId":{"type":"string","description":"Unique identifier (UUID) of the plugin."},"name":{"type":"string","description":"Display name of the plugin."},"description":{"type":["string","null"],"description":"Description of the plugin."},"url":{"type":"string","description":"Production URL where the plugin is hosted. Sigma loads the plugin from this URL when it is added to a workbook. An empty string indicates that no production URL has been set for the plugin yet."},"devUrl":{"type":["string","null"],"description":"Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode."},"type":{"type":"string","enum":["element"]}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["plugins"]},"delete":{"summary":"Delete a plugin","description":"Permanently delete a plugin. Workbook elements that reference the deleted plugin remain in their workbooks but can no longer render plugin content.\n\n### Usage notes\n- Retrieve the **pluginId** by calling the [/v2/plugins](/reference/list-custom-plugins) endpoint.\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type or an account type with the **Manage plugins** permission enabled.","parameters":[{"name":"pluginId","schema":{"type":"string","description":"Unique identifier (UUID) of the plugin."},"in":"path","required":true}],"operationId":"deleteCustomPlugin","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["plugins"]}},"/v2/query/{queryId}/download":{"get":{"summary":"Download an exported file","description":"After making a request to the [/v2/workbooks/{workbookId}/export](https://help.sigmacomputing.com/reference/export-workbook) or [/v2/reports/{reportId}/export](https://help.sigmacomputing.com/reference/export-report) endpoint, you can use this endpoint to download the exported file using the queryId returned in the response.\n\n### Usage notes\n\n- This endpoint is rate limited to 400 requests per minute.\n- The export must be ready to download before you can download the results. The endpoint returns an error if the query is still processing or if the `queryId` is invalid or expired. Query results are typically available for a limited time, so make sure to download query results while they are available.\n- Retrieve the **queryId** by making a request to the [/v2/workbooks/{workbookId}/export](https://help.sigmacomputing.com/reference/export-workbook) or [/v2/reports/{reportId}/export](https://help.sigmacomputing.com/reference/export-report) endpoint.\n- Specify the file format when you make the export request. You cannot specify the file format when you download the file.\n\n### Usage scenarios\n- **Scheduled reporting**: Automate the downloading of reports generated on a scheduled basis.\n- **Data analysis**: Retrieve large sets of data for local analysis in external tools not integrated directly with Sigma.\n\n### Best practices\n- Monitor the status of the export query before attempting a download to make sure it is ready. For a code example, see [Export to CSV with Date Range Parameters](https://help.sigmacomputing.com/recipes/workbook-export-to-csv-with-date-range-parameters).\n- Handle errors gracefully in your application, providing users with clear messages regarding the status of their requested downloads.","parameters":[{"name":"queryId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"downloadQuery","responses":{"200":{"description":"The response body.","content":{"text/csv":{"schema":{"type":"string","format":"binary"}},"text/plain":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"204":{"description":"The export is still processing. Retry the request once it completes."},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["query"]}},"/v2/reports":{"get":{"summary":"List reports","description":"This endpoint retrieves a list of all available reports.\n\nAvailable reports include any reports in your My Documents folder and any reports you have access to.\n\nUsers with the Admin account type can optionally retrieve all reports in the organization.\n\n### Usage notes\nThis endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.\n\n### Pagination\n\nThis endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:\n\n- hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.\n- total: The total number of entries available across all pages.\n- nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.\n\n#### Example response for pagination\n```json\n{\n  \"hasMore\": true,\n  \"total\": 104,\n  \"nextPage\": \"50\"\n}\n```\n\nTo request additional pages, include the `nextPage` option in your next request as the value of the `page` option. Repeat this process until `nextPage` returns `null`, indicating that there are no more pages to return.\n\n### Usage scenarios\n- **Report navigation**: Allows users to view their collection of reports and locate ones they need.\n- **Integration points**: Useful for building integrations that need to present users with a list of their available reports, such as in custom applications using embeds.","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"excludeTags","schema":{"type":"boolean"},"in":"query"},{"name":"skipPermissionCheck","schema":{"type":"boolean","description":"Only available to Sigma admins. Return all reports regardless of whether the user has access."},"in":"query"},{"name":"isArchived","schema":{"type":"boolean","description":"Return archived reports."},"in":"query"}],"operationId":"listReports","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["reportId","reportUrlId","name","url","path","latestVersion","ownerId"],"properties":{"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"reportUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"allOf":[{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}},{"type":"object","required":["taggedReportId"],"properties":{"taggedReportId":{"type":"string","description":"Unique identifier of the tagged report.","title":"Report ID"}}}]}},"description":{"type":"string"}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]},"post":{"summary":"Create a report","description":"This endpoint lets you create an empty report in Sigma, enabling you to build presentation-ready documents for sharing insights with stakeholders.\n\n### Usage notes\n- The **name** parameter is required to provide a name for the new report.\n- Use the **folderId** to specify the folder in which to save the report. Retrieve the **folderId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n\n### Usage scenarios\n- **Reliable export formatting**: Users can quickly generate a new blank report to create predictable, paginated exports.\n\n### Best practices\n- **Naming conventions**: Establish and follow consistent naming conventions for reports to make it easier to manage and identify them within larger projects.\n- **Folder organization**: Use the **folderId** to organize reports into relevant folders, which helps in maintaining a tidy workspace, especially in environments with multiple users or teams.\n- **Access control**: Regularly review and manage access permissions for new reports, ensuring that only the appropriate personnel can view or edit sensitive data.","parameters":[],"operationId":"createReport","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["folderId","name"],"properties":{"folderId":{"type":"string","description":"ID of the folder where the new report is created.","title":"Folder ID"},"name":{"type":"string","description":"Name of the new report.","title":"Report Name"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the report.","title":"Description"}}}]},"examples":{"Create a blank report":{"value":{"folderId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff","name":"My new blank Report","description":"This is a description"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["reportId","reportUrlId","name","url","path","latestVersion","ownerId"],"properties":{"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"reportUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"allOf":[{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}},{"type":"object","required":["taggedReportId"],"properties":{"taggedReportId":{"type":"string","description":"Unique identifier of the tagged report.","title":"Report ID"}}}]}},"description":{"type":"string"}}}]},"examples":{"Response Example":{"value":{"reportId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff","reportUrlId":"57a96EMo3GVJG73179MV2l","name":"My new blank Report","url":"https://example.com/reports/88889999-aaaa-bbbb-cccc-ddddeeeeffff","path":"folder1","latestVersion":1,"isArchived":false,"createdAt":"2022-01-01T00:00:00.000Z","createdBy":"user1","updatedAt":"2022-01-01T00:00:00.000Z","updatedBy":"user1","ownerId":"user1"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}":{"get":{"summary":"Get a report","description":"This endpoint retrieves a report by its unique identifier (`reportId`). It provides detailed information about the report, including its name, URL, path, and other metadata.\n\n### Usage notes\n- The **reportId** parameter must be a valid UUID that uniquely identifies the report. Invalid or nonexistent IDs return an error. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n\n### Usage scenarios\n- **Report search**: Allows users to view all of their reports and locate a specific one, as well as filter by criteria such as if it is archived.\n- **Data retrieval**: Developers can use this endpoint to programmatically retrieve details about a specific report to display its content or metadata in a custom user interface.\n- **Integration**: Use this endpoint for integrations where other systems need to fetch report details based on an ID provided through another interface or workflow.\n\n### Best practices\n- Validate the **reportId** on the client side before making a request to avoid unnecessary server load caused by invalid requests.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true}],"operationId":"getReport","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["reportId","reportUrlId","name","url","path","latestVersion","ownerId"],"properties":{"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"reportUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"allOf":[{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}},{"type":"object","required":["taggedReportId"],"properties":{"taggedReportId":{"type":"string","description":"Unique identifier of the tagged report.","title":"Report ID"}}}]}},"description":{"type":"string"}}}]},"examples":{"Response Example":{"value":{"reportId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff","reportUrlId":"57a96EMo3GVJG73179MV2l","name":"My report","url":"https://example.com/reports/88889999-aaaa-bbbb-cccc-ddddeeeeffff","path":"folder1","latestVersion":1,"createdAt":"2022-01-01T00:00:00.000Z","createdBy":"user1","updatedAt":"2023-01-01T00:00:00.000Z","updatedBy":"user2","ownerId":"user1","isArchived":false,"tags":[{"versionTagId":"11112222-3333-4444-5555-666677778888","tagName":"Production","sourceVersion":3,"taggedReportId":"aaaabbbb-cccc-dddd-eeee-ffff00001111","taggedAt":"2024-06-15T12:00:00.000Z"}],"description":"Describe my report"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/columns":{"get":{"summary":"List columns for all elements in a report","description":"This endpoint retrieves all columns in a report for all data elements in the report.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n\n### Usage scenarios\n- **Data exploration:** Enable users to explore the data structure of a report element, facilitating deeper analysis and understanding.\n- **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately.\n\n### Best practices\n- Use this endpoint when setting up interfaces that require specific knowledge about the data structure.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listReportColumns","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["columnId","name","formula","type","elementId"],"properties":{"columnId":{"type":"string","description":"Column ID"},"name":{"type":"string","description":"Column name"},"formula":{"type":"string","description":"Column formula or source column reference."},"type":{"type":"object","description":"The column's data type, represented as a recursive type object."},"elementId":{"type":"string","description":"Element ID"}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/controls":{"get":{"summary":"List report controls","description":"This endpoint retrieves all control elements within a specific report. Control elements provide predefined interactions to users viewing a report, such as inputs that modify data or selections to filter data.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- To retrieve controls from a version-tagged report, pass the tag name in the  `tagName` query parameter. Retrieve the tag name by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint and using the `tags.tagName` field in the response.\n\n### Usage scenarios\n- **Dynamic data interaction:** Allows users to interact dynamically with the data presented in the report through various control mechanisms.\n- **Custom reporting:** Enables the creation of customizable reports where end users can adjust parameters to filter and sort data according to their requirements.\n\n### Best practices\n- Ensure proper access controls are set to manage who can view or interact with the controls to prevent unauthorized data manipulation.\n- Use detailed and descriptive names for controls to facilitate easier identification and use by end users.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"},{"name":"tagName","schema":{"type":"string","description":"Specifies the version tag of the report whose controls should be listed.","title":"Version tag"},"in":"query"}],"operationId":"listReportControls","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["name","valueType"],"properties":{"name":{"type":"string"},"valueType":{"oneOf":[{"type":"string","enum":["boolean"]},{"type":"string","enum":["number"]},{"type":"string","enum":["text"]},{"type":"string","enum":["date"]},{"type":"string","enum":["number-list"]},{"type":"string","enum":["text-list"]},{"type":"string","enum":["date-list"]},{"type":"string","enum":["boolean-list"]},{"type":"string","enum":["date-range"]},{"type":"string","enum":["number-range"]},{"type":"string","enum":["date-null"]},{"type":"string","enum":["number-null"]},{"type":"string","enum":["text-null"]},{"type":"string","enum":["boolean-null"]}],"description":"Value of the control"}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/copy":{"post":{"summary":"Duplicate a report","description":"This endpoint lets you duplicate an existing report. The report copy can be placed in a different folder from the original report, potentially with a different name and description.\n\n### Usage notes\n- The `reportId` parameter specifies the original report to be copied. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- The `destinationFolderId` in the request body specifies where to place the new report.\n  - To use the \"My Documents\" folder for a specific user as the destination folder, call the [/v2/members/{memberId}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response.\n  - Retrieve the **folderId** of all folders by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n\n### Usage scenarios\n- **Reuse report structure**: Use an existing report as a baseline to make changes to.\n- **Backup**: Make a backup of a report before making significant changes.\n\n### Best practices\n- Always verify that the destination folder has the correct permissions set to avoid access issues.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true}],"operationId":"copyReport","requestBody":{"description":"Body parameters for copying a report.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["destinationFolderId","name"],"properties":{"destinationFolderId":{"type":"string","description":"ID of the folder in which to place the copied report.","title":"Destination Folder ID"},"name":{"type":"string","description":"Name for the copied report as it appears in Sigma.","title":"New Report Name"}}},{"type":"object","properties":{"description":{"type":"string","description":"A description for the new report.","title":"New Description"}}}],"description":"Body parameters for copying a report."}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["reportId","reportUrlId","name","url","path","latestVersion","ownerId"],"properties":{"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"reportUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"allOf":[{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}},{"type":"object","required":["taggedReportId"],"properties":{"taggedReportId":{"type":"string","description":"Unique identifier of the tagged report.","title":"Report ID"}}}]}},"description":{"type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/elements":{"get":{"summary":"List elements in a report","description":"This endpoint retrieves all elements in a report, which lets you understand and interact with the individual components that make up the report, such as charts, tables, or controls.\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- To retrieve elements from version-tagged reports, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint and using the `tags.name` included in the response for a given report.\n### Usage scenarios\n- **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation.\n- **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with.\n### Best practices\n- Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience.\n- Validate both the reportId and pageId to ensure they correspond to valid, accessible resources before making API calls.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"},{"name":"tagName","schema":{"type":"string","description":"Specifies the version tag of the report whose elements should be listed.","title":"Version tag"},"in":"query"}],"operationId":"listReportElements","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"columns":{"type":"array","items":{"type":"string"}},"vizualizationType":{"type":"string"},"error":{"type":"string"}}}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/elements/{elementId}/columns":{"get":{"summary":"List columns for a report element","description":"This endpoint retrieves a list of columns associated with a specific element within a report. It provides metadata about each column, such as name and formula, which can be essential for understanding the data structure and for further data manipulation or analysis.\n\n  ### Usage notes\n  - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n  - Retrieve the **elementId** by first calling the [/v2/reports/{reportId}/pages](listreportpages) endpoint, then calling the [/v2/reports/{reportId}/pages/{pageId}/elements](listreportpageelements) endpoint.\n  - The element that you request must be a data element, such as a table, pivot table, or visualization. Requesting a UI or control element returns an error.\n  - To retrieve element columns from a version-tagged report, pass the `tagName` query parameter with the tag name. Retrieve the tag name by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint and using the `tags.tagName` field in the response.\n\n  ### Usage scenarios\n  - **Data exploration:** Helps users explore the data structure of a report element, facilitating deeper analysis and understanding.\n  - **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately.\n\n  ### Best practices\n  - Validate the **elementId** to make sure it corresponds to the correct report element before querying.\n  - Leverage this endpoint when setting up interfaces that require specific knowledge about the data structure.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the report element.","title":"Element ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"},{"name":"tagName","schema":{"type":"string","description":"Specifies the version tag of the report whose element columns should be listed.","title":"Version tag"},"in":"query"}],"operationId":"listReportElementColumns","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["columnId","label","formula","type"],"properties":{"columnId":{"type":"string","description":"Column ID"},"label":{"type":"string","description":"Column name"},"formula":{"type":"string","description":"Column formula"},"type":{"type":"object","description":"The column's data type, represented as a recursive type object."}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/elements/{elementId}/query":{"get":{"summary":"Get the SQL query for a report element","description":"This endpoint retrieves the SQL query associated with a specific element in a report. It allows users to view and understand how the data for that element is being processed and transformed.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- Retrieve the **elementId** by first calling the [/v2/reports/{reportId}/pages](listreportpages) endpoint, then calling the [/v2/reports/{reportId}/pages/{pageId}/elements](listreportpageelements) endpoint.\n\n### Usage scenarios\n- **Development and debugging:** Provides developers and analysts with the ability to retrieve and review the SQL code behind report elements, facilitating troubleshooting and enhancements.\n- **Educational insight:** Useful for training purposes or for users learning to understand the impact of various transformations and filters applied within their reports.\n\n### Best practices\n- Ensure proper access controls are in place to manage who can view potentially sensitive query information.\n- Use this endpoint as part of a regular review process to ensure that all queries are optimized and up to date with current data schemas.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the element","title":"Element ID"},"in":"path","required":true}],"operationId":"getReportElementQuery","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"sql":{"type":"string"},"error":{"type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/export":{"post":{"summary":"Export data from a report","description":"This endpoint lets you create a file containing data exported from a report. Export the entire report or a single report page. Reports are exported as PDF documents.\n\nSuccessful requests return a **queryId**. Use the **queryId** with the [/v2/query/{queryId}/download](https://help.sigmacomputing.com/reference/download-query) endpoint to download the file when it is ready. See [Download an exported file](https://help.sigmacomputing.com/reference/download-query).\n\nTo export a report to a specific destination or recipient, see the [/v2/reports/{reportId}/send](https://help.sigmacomputing.com/reference/send-report) endpoint.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- This endpoint is rate limited to 400 requests per minute.\n- If a page contains an expanded table, all pages of that table's data are included in the export, even if only the first page of the table is selected. \n- Only PDF exports are supported. Use the `layout` parameter to specify either `portrait` or `landscape` layout.\n- For security and privacy reasons, the `queryId` used to download the exported file expires 1 hour after your request is received. You can extend this to 6 hours using the `resultsValidityTimeMs` parameter.\n\n### Usage scenarios\n- **Conditional report export**: Based on an external set of conditions, export a report from Sigma.\n- **Integration**: Integrate enriched and analyzed data with other applications, providing the necessary data in a format that these applications can process.\n\n### Best practices\n- Clearly specify parameters to retrieve only the necessary data, optimizing performance and reducing network load.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true}],"operationId":"exportReport","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"oneOf":[{"type":"object","required":["format"],"properties":{"format":{"type":"object","required":["type","layout"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"type":"string","enum":["portrait","landscape"]}}}},"description":"Export an entire report","title":"Export an entire report"},{"type":"object","required":["pageId","format"],"properties":{"pageId":{"type":"string","description":"Identifier of the report page."},"format":{"type":"object","required":["type","layout"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"type":"string","enum":["portrait","landscape"]}}}},"description":"Export a page of a report","title":"Export a page of a report"}]},{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value.\n\n**Syntax**\n{ control-id: control-value }\n\nThe control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.\n\nValues can take multiple forms, depending on the data type of the control:\n\n**Boolean**\n\n- Single value: \"true\" | \"false\" | \":null\"\n- List of Boolean: \"true,false,:null\" (No space after the comma.)\n\n**Number**\n\n- Single value: \"10.54\", \":null\"\n- List of values: \"10.54,23.45,:null\" (No space after the comma.)\n- Range of numbers: \"min:10.54,max:23.45\" (No space after the comma or colon.)\n\n**Text**\n\n- Single value: \"some-text\" | \":null\" | \":empty\"\n- List of values: \"some-text,more-text,:null,:empty\" (No space after the comma.)\n\n**Date**\n\nAll dates use UTC time zones.\n\n- Fixed date using ISO-6801 format: \"2022-01-01T01:01:59\" | \":null\"\n    - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):\n        - %Y-%m-%d\n        - %Y-%m-%dT%H:%M\n        - %Y-%m-%dT%H:%M:%S\n- List of fixed dates: \"2022-01-01T01:01:59,2022-02-02T02:02:59,:null\"\n- Relative date: \"prior-day-3\" | \"next-day-3\"\n    - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]\n- Date range: \"min:2022-01-01T01:01:59,max:next-day-3\" (No spaces after the comma or colon.)\n    - Leave max blank for \"on or after\" and min blank for \"on or before\", for example:\n        - \"Date-Range\": \"min:2020-04-01,max:\"\n        - \"Date-Range\": \"min:,max:next-day-3\"\n\n**Notes**\n\n- \":null\" is a special value that denotes the null primitive value.\n- \":empty\" is a special value that denotes the empty string \"\".\n\nUse [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.\n\nFor example:\n\"New York, NY,Boston, MA\" can be encoded as:\n\n\"New%20York%2C%20NY,Boston%2C%20MA\""},"timeout":{"type":"number","description":""},"tag":{"type":"string","description":"Specifies the version tag of the report to be exported."}}}]},"examples":{"Request Example":{"value":{"format":{"type":"pdf","layout":"portrait"},"parameters":{"region":"North America"},"timeout":5,"tag":"my-tag"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["jobComplete","queryId"],"properties":{"jobComplete":{"type":"boolean"},"queryId":{"type":"string"}}},{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","additionalProperties":{}}},"message":{"type":"string"}}}]},"examples":{"Response Example":{"value":{"jobComplete":false,"queryId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/grants":{"post":{"summary":"Grant permissions on a report to users or teams","description":"You can use this endpoint to grant specific document permissions on a specific report to users or teams.\n\n   ### Usage notes\n\n   - Ensure the **reportId** in the path is valid and that the user has rights to modify its permissions. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n   - Do not set both **memberId** and **teamId** in the same **grantee** object. Instead, choose one based on the target of the grant.\n\n     - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n     - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n   - Grant permissions on a specific version tag of a report by specifying the **tagId**. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.\n\n   ### Usage scenarios\n\n   - **Team collaboration**: Granting edit permissions to a team for collaborative work on a project.\n   - **External access sharing**: Providing view access to an external consultant.\n\n   ### Best practices\n\n   - Validate user and team IDs before submitting them in a request to avoid errors.\n   - Use the **tagId** to help manage and revoke grants systematically as project requirements change.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true}],"operationId":"createReportGrant","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","items":{"allOf":[{"type":"object","required":["grantee","permission"],"properties":{"grantee":{"oneOf":[{"type":"object","required":["memberId"],"properties":{"memberId":{"type":"string"}},"description":"The UUID of the member receiving the grant","title":"Member"},{"type":"object","required":["teamId"],"properties":{"teamId":{"type":"string"}},"description":"The UUID of the team receiving the grant","title":"Team"}]},"permission":{"type":"string","enum":["view","edit"],"description":"Permission to grant for access to the report.","title":"ReportPermission"}}},{"type":"object","properties":{"tagId":{"type":"string"}}}]}}},"title":"Report grant creation request"}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/grants/{grantId}":{"delete":{"summary":"Delete a report grant","description":"This endpoint deletes a specific grant from a report. Deleting a grant revokes the permissions associated with it, ensuring that the specified users or teams no longer have the access rights previously granted.\n\n  ### Usage notes\n  - **reportId:** The identifier of the report from which the grant is to be deleted. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n  - **grantId:** The identifier of the grant that needs to be removed. Retrieve the **grantId** by calling the [/v2/grants](https://help.sigmacomputing.com/reference/list-grants) endpoint with the `reportId` as the `inodeId`.\n\n  ### Usage scenarios\n  - **Access revocation:** Administrators can use this endpoint to manage and revoke access as team roles or project needs evolve.\n  - **Security compliance:** Ensures that access to sensitive data within reports is tightly controlled and can be promptly adjusted in response to security policy changes or personnel updates.\n\n  ### Best practices\n  - Always confirm the identities associated with both the report and grant before proceeding with deletion to avoid accidental revocations.\n  - Log and audit all grant deletions to maintain records for security audits and compliance tracking.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"grantId","schema":{"type":"string","description":"Unique identifier of the grant.","title":"Grant ID"},"in":"path","required":true}],"operationId":"deleteReportGrant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/lineage":{"get":{"summary":"List lineage for a report","description":"This endpoint lists the data elements in a report and their dependencies and relationships, providing a detailed view of how data is interconnected within a report.\n\n  ### Usage notes\n  - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n\n  ### Usage scenarios\n  - **Data governance:** Allows data managers to track how information is used and propagated through different report elements.\n  - **Debugging and optimization:** Helps with identifying and resolving issues in data processing or report structure.\n  - **Data source management**: Identify the dependencies of data sources in use in a specific report.\n\n  ### Best practices\n  - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams.\n  - Use this endpoint to regularly audit report structures, ensuring that all data connections and transformations are correct and optimized.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listReportLineageTree","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["sourceIds","elementId","dataSourceIds"],"properties":{"sourceIds":{"type":["array","null"],"items":{"type":"string"},"description":"List of direct sources for the element. Either element IDs or data source IDs."},"elementId":{"type":"string","description":"Unique identifier of the element"},"dataSourceIds":{"type":["array","null"],"items":{"type":"string"},"description":"List of root sources for the element as data source IDs."}}}],"description":"","title":"Element details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["dataModelId"],"properties":{"dataModelId":{"type":"string"}}}],"description":"","title":"Source data model details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["inodeId"],"properties":{"inodeId":{"type":"string"}}}],"description":"","title":"Source table or dataset (deprecated) details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["definition"],"properties":{"definition":{"type":"string","description":"","title":"Custom SQL definition"}}}],"description":"","title":"Source custom SQL details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["csvId"],"properties":{"csvId":{"type":"string","description":"Unique identifier of the uploaded CSV file","title":"CSV ID"}}}],"description":"","title":"Source CSV upload details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["semanticViewId","semanticViewTable"],"properties":{"semanticViewId":{"type":"string","description":"Unique identifier of the semantic view","title":"Semantic view ID"},"semanticViewTable":{"type":"string","description":"Name of the table within the semantic view","title":"Semantic view table"}}}],"description":"","title":"Source semantic view details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["sqlDocumentId"],"properties":{"sqlDocumentId":{"type":"string"}}}],"description":"","title":"Source SQL document details (deprecated)"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["worksheetId"],"properties":{"worksheetId":{"type":"string","description":"Unique identifier of the worksheet","title":"Worksheet ID"}}}],"description":"","title":"Source worksheet details (deprecated)"}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/lineage/elements/{elementId}":{"get":{"summary":"List lineage of a report element","description":"This endpoint retrieves the lineage and dependencies of a specific report element. It provides a detailed view of how data is interconnected within a report, which can be critical for understanding data sources and dependencies.\n\n  ### Usage notes\n  - **reportId:** The UUID of the report containing the element. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n  - **elementId:** The UUID of the element within the report whose lineage is being queried. Retrieve the **elementId** by first calling the [/v2/reports/{reportId}/pages](listreportpages) endpoint, then calling the [/v2/reports/{reportId}/pages/{pageId}/elements](listreportpageelements) endpoint.\n  - The element that you request must be a data element, such as a table, pivot table, or visualization. Requesting a UI or control element returns an error.\n\n  ### Usage scenarios\n  - **Data governance:** Allows data managers to track how information is used and propagated through different report elements.\n  - **Debugging and optimization:** Helps in identifying and resolving issues in data processing or in the structure of report setups.\n  - **Data source management**: Identify the data sources in use in a specific report.\n\n  ### Best practices\n  - Use this endpoint to regularly audit report structures, ensuring that all data connections and transformations are correct and optimized.\n  - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the element","title":"Element ID"},"in":"path","required":true}],"operationId":"listReportElementLineage","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["dependencies","edges"],"properties":{"dependencies":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["nodeId","type"],"properties":{"nodeId":{"type":"string"},"type":{"type":"string"}},"description":"","title":"Element details"},{"allOf":[{"type":"object","required":["nodeId","type"],"properties":{"nodeId":{"type":"string"},"type":{"type":"string"}}},{"type":"object","required":["name","elementId"],"properties":{"name":{"type":"string"},"elementId":{"type":"string"}}}],"description":"","title":"Sheet details"},{"allOf":[{"type":"object","required":["nodeId","type"],"properties":{"nodeId":{"type":"string"},"type":{"type":"string"}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}],"description":"","title":"Data source details"},{"allOf":[{"type":"object","required":["nodeId","type"],"properties":{"nodeId":{"type":"string"},"type":{"type":"string"}}},{"type":"object","required":["name","semanticViewTable"],"properties":{"name":{"type":"string"},"semanticViewTable":{"type":"string"}}}],"description":"","title":"Semantic view details"}],"type":"object"}},"edges":{"type":"array","items":{"type":"object","required":["source","target","type"],"properties":{"source":{"type":"string"},"target":{"type":"string"},"type":{"type":"string","enum":["lookup","source","dependency"]}}}}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/pages":{"get":{"summary":"List report pages","description":"This endpoint retrieves a list of all pages contained within a specified report. It is useful for applications needing to display an overview or navigate through different pages of a report.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- To retrieve pages from a version-tagged report, pass the `tag` query parameter with the tag name. Retrieve the tag name by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint and using the `tags.tagName` field in the response.\n\n### Usage scenarios\n- **Navigation:** Helps users and applications navigate through different pages of a report efficiently.\n- **Content discovery:** Allows users to quickly view and access the variety of pages contained within a report.\n\n### Best practices\n- Utilize pagination to manage and streamline the retrieval of large numbers of pages.\n- Ensure that users or systems querying this endpoint have appropriate permissions to access the report's content.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"},{"name":"tag","schema":{"type":"string","description":"Specifies the version tag of the report whose pages should be listed.","title":"Version tag"},"in":"query"}],"operationId":"listReportPages","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["pageId"],"properties":{"pageId":{"type":"string","description":"Unique identifier of the report page.","title":"Page ID"}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name of the report page.","title":"Page name"},"hidden":{"type":"boolean","description":"Whether the page is hidden from end users.","title":"Hidden"}}}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/pages/{pageId}/elements":{"get":{"summary":"List elements in a report page","description":"This endpoint retrieves all elements from a specific page within a report, which lets you understand and interact with the individual components that make up the page, such as charts, tables, or controls.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- Retrieve the **pageId** by calling the [/v2/reports/{reportId}/pages](listreportpages) endpoint.\n- To retrieve elements from a version-tagged report, pass the `tagName` query parameter with the tag name. Retrieve the tag name by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint and using the `tags.tagName` field in the response.\n\n### Usage scenarios\n- **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation.\n- **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with.\n\n### Best practices\n- Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience.\n- Validate both the reportId and pageId to ensure they correspond to valid, accessible resources before making API calls.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"pageId","schema":{"type":"string","description":"Unique identifier of the report page.","title":"Page ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"},{"name":"tagName","schema":{"type":"string","description":"Specifies the version tag of the report whose elements should be listed.","title":"Version tag"},"in":"query"}],"operationId":"listReportPageElements","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"columns":{"type":"array","items":{"type":"string"}},"vizualizationType":{"type":"string"},"error":{"type":"string"}}}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/queries":{"get":{"summary":"List SQL queries in a report","description":"This endpoint retrieves a list of all SQL queries stored within a specific report. \n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n\n### Usage scenarios\n- **Audit and review:** Enables administrators and data governance teams to audit and review all the queries associated with a report for compliance and optimization.\n- **Query optimization:** Allows users to identify and optimize potentially inefficient or slow queries to improve performance.\n\n### Best practices\n- Use pagination to manage large sets of queries efficiently, especially in reports with extensive data manipulation.\n- Regularly review queries as part of data governance practices to ensure they remain up to date and perform optimally.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listReportQueries","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"sql":{"type":"string"},"error":{"type":"string"}}}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/schedules":{"get":{"summary":"List scheduled report exports","description":"This endpoint retrieves a list of all scheduled exports for a specified report. These schedules represent planned events that can trigger exports based on various conditions and timings.\n\n  ### Usage Notes\n  - The **reportId** in the path parameter identifies the report whose scheduled exports are to be listed. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n  - Use pagination query parameters to manage the volume of data returned by this endpoint.\n\n  ### Usage Scenarios\n  - **Schedule overview**: Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a report.\n  - **Audit and compliance**: This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies.\n\n  ### Best Practices\n  - Implement client-side handling to manage paginated data effectively, especially in cases where a report has a large number of scheduled exports.\n  - Regularly audit schedules to keep them up-to-date and aligned with current workflows.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listReportSchedules","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["scheduledNotificationId","reportId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"workbookExportSource":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["report"]}}}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"reportSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"reportVariant":{"type":"object","properties":{"tagId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]},"post":{"summary":"Add report schedule","description":"This endpoint allows you to create a scheduled export of a report. Scheduled exports are triggered by specific conditions or timings.\n\n  ### Usage notes\n  - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n  - Retrieve relevant IDs based on the export contents and destination:\n    - To export to one or more Sigma users, retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n    - To export to one or more Sigma teams, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  - Reports can only be exported as entire PDFs. Exporting a specific page or element is not supported.\n  - If you want to impersonate a user when scheduling a report export, use the [/v2/auth/token](https://help.sigmacomputing.com/reference/post-token) endpoint.\n\n  ### Usage scenarios\n  - **Periodic reporting**: Use this endpoint to trigger routine report exports at specific intervals (such as weekly or monthly) or when specific business conditions are met (such as specific sales targets or usage thresholds).\n\n  ### Best practices\n  - Regularly review and audit schedules to ensure unnecessary or expensive schedules are not being added.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true}],"operationId":"createReportSchedule","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["target","schedule","configV2"],"properties":{"target":{"type":"array","items":{"type":"object","properties":{"teamId":{"type":"string","description":"Unique identifier of the team to export to"},"email":{"type":"string","description":"Email address to export to"},"ccEmail":{"type":"string","description":"Email address to add as a Cc recipient"},"bccEmail":{"type":"string","description":"Email address to add as a Bcc recipient"},"ccTeamId":{"type":"string","description":"Unique identifier of the team to add as a Cc recipient"},"bccTeamId":{"type":"string","description":"Unique identifier of the team to add as a Bcc recipient"},"slackConversationId":{"type":"string","description":"Slack channel ID or member ID to export to"},"googleSpreadsheetUrl":{"type":"string","description":"URL of the Google Sheet to export to"},"googleDriveFolderUrl":{"type":"string","description":"URL of the Google Drive folder to export to"},"webhookUrl":{"type":"string","description":"URL of the webhook endpoint to export to"}}},"description":"One or more targets to send the report to."},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}},"description":"When to send the report export."},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","exportAttachments"],"properties":{"title":{"type":"string","description":"Title of the message"},"messageBody":{"type":"string","description":"Body of the message"},"exportAttachments":{"type":"array","items":{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}],"description":"Export format options. Reports only support PDF."}}},"description":"Attachments to include in the export. Reports only support PDF."}}},{"type":"object","properties":{"exportName":{"type":"string","description":"Name of the scheduled export","title":"Export name"},"includeLink":{"type":"boolean","description":"Include a link to the exported report","title":"Include link"},"runAsRecipient":{"type":"boolean","description":"Run the export queries as the recipient","title":"Run as recipient"},"attachmentSettings":{"type":"object","properties":{"mergeAttachments":{"type":"boolean","description":"Combines multiple PDF attachments into a single file","title":"Merge attachments"},"zipAttachments":{"type":"boolean","description":"Send attachments as a .zip file","title":"Zip attachments"}},"description":"Export attachment settings","title":"Export attachment settings"},"reportVariant":{"type":"object","properties":{"tagId":{"type":"string","description":"Version tag to export","title":"Version tag ID"}},"description":"Report variant","title":"Report variant"},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}},"description":"Always send the export","title":"Always"},{"type":"object","required":["type","condition"],"properties":{"type":{"type":"string","enum":["workbook"]},"condition":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isEmpty"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"}},"description":"If there's no data","title":"Element is empty"},{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"}},"description":"If there's data","title":"Element is not empty"},{"allOf":[{"type":"object","required":["type","elementId","columnId","op","mode"],"properties":{"type":{"type":"string","enum":["column"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"},"columnId":{"type":"string","description":"ID of the column","title":"Column ID"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNull","IsNotNull","Contains","StartsWith","EndsWith"],"description":"Operator","title":"Operator"},"mode":{"type":"string","enum":["any","all"],"description":"Kind of condition evaluation","title":"Condition check"}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"description":"Boolean value","title":"Boolean value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["integer"]},"value":{"type":"string"}},"description":"Integer value","title":"Integer value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"}],"description":"Column value","title":"Column value"}}}],"description":"If a condition is met","title":"Column meets condition"}]}},"description":"Send the export based on a condition","title":"Workbook condition"}],"description":"Export condition options","title":"Export condition options"},"reportSettings":{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"description":"Boolean value","title":"Boolean value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"description":"Number value","title":"Number value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"}},"description":"Date value","title":"Date value"}],"description":"Scalar value","title":"Scalar value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"allOf":[{"type":"object","required":["true","false"],"properties":{"true":{"type":"boolean"},"false":{"type":"boolean"}}},{"type":"object","properties":{"null":{"type":"boolean"}}}]}},"description":"Boolean list value","title":"Boolean list value"},{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"description":"Number value","title":"Number value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}},"description":"Null number value","title":"Null number value"}]}}},"description":"Number list value","title":"Number list value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}},"description":"Null text value","title":"Null text value"}]}}},"description":"Text list value","title":"Text list value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}]}}},"description":"Date list value","title":"Date list value"}],"description":"List value","title":"List value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["hierarchical-list"]},"value":{"type":"array","items":{"type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"}},"description":"Array of hierarchy paths. Each path is an array of segments, from the highest selected level of the hierarchy down to the lowest selected level of the hierarchy. Each segment is a `{type: \"text\", value: string}` object. For example, a Region/State/City hierarchy control with Oakland selected would be represented as `[[{\"type\":\"text\",\"value\":\"West\"}, {\"type\":\"text\",\"value\":\"California\"}, {\"type\":\"text\",\"value\":\"Oakland\"}]]`","title":"Hierarchy paths"}},"description":"Hierarchical list value","title":"Hierarchical list value"},{"type":"object","required":["type","min","max"],"properties":{"type":{"type":"string","enum":["date-range"]},"min":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"},"max":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"}},"description":"Date range value","title":"Date range value"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"min":{"type":"number","description":"Minimum value of the range","title":"Minimum value"},"max":{"type":"number","description":"Maximum value of the range","title":"Maximum value"}}}],"description":"Number range value","title":"Number range value"},{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}},"description":"Null number value","title":"Null number value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}},"description":"Null text value","title":"Null text value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}},"description":"Null boolean value","title":"Null boolean value"}],"description":"Null value","title":"Null value"}],"description":"Variable value","title":"Variable value","type":"object"},"description":"This object maps control IDs to the values that they should have when exporting the workbook.","title":"Control values"}},"description":"Report settings","title":"Report settings"}}}],"description":"Configuration settings for the export schedule."}}},{"type":"object","properties":{"description":{"type":["string","null"],"description":"Description of the scheduled export"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["scheduledNotificationId","reportId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"workbookExportSource":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["report"]}}}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"reportSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"reportVariant":{"type":"object","properties":{"tagId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/schedules/{scheduleId}":{"patch":{"summary":"Update a report schedule","description":"This endpoint allows you to update an existing scheduled report export.\n\n  ### Usage notes\n  - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n  - Retrieve the **scheduleId** by calling the [/v2/reports/{reportId}/schedules](https://help.sigmacomputing.com/reference/list-report-schedules) endpoint.\n  - To add or update a team recipient, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n\n  ### Usage scenarios\n  - **Audit schedules**: Update schedules to ensure they are being exported at the correct times or to the correct recipients.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"scheduleId","schema":{"type":"string","description":"Unique identifier of the schedule.","title":"Schedule ID"},"in":"path","required":true}],"operationId":"updateReportSchedule","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"target":{"type":"array","items":{"type":"object","properties":{"teamId":{"type":"string","description":"Unique identifier of the team to export to"},"email":{"type":"string","description":"Email address to export to"},"ccEmail":{"type":"string","description":"Email address to add as a Cc recipient"},"bccEmail":{"type":"string","description":"Email address to add as a Bcc recipient"},"ccTeamId":{"type":"string","description":"Unique identifier of the team to add as a Cc recipient"},"bccTeamId":{"type":"string","description":"Unique identifier of the team to add as a Bcc recipient"},"slackConversationId":{"type":"string","description":"Slack channel ID or member ID to export to"},"googleSpreadsheetUrl":{"type":"string","description":"URL of the Google Sheet to export to"},"googleDriveFolderUrl":{"type":"string","description":"URL of the Google Drive folder to export to"},"webhookUrl":{"type":"string","description":"URL of the webhook endpoint to export to"}}},"description":"One or more targets to send the report to."},"schedule":{"type":"object","properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}},"description":"When to send the report export."},"configV2":{"type":"object","properties":{"title":{"type":"string","description":"Title of the message"},"messageBody":{"type":"string","description":"Body of the message"},"exportAttachments":{"type":"array","items":{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}],"description":"Export format options. Reports only support PDF."}}},"description":"Attachments to include in the export. Reports only support PDF."},"exportName":{"type":"string","description":"Name of the scheduled export","title":"Export name"},"includeLink":{"type":"boolean","description":"Include a link to the exported report","title":"Include link"},"runAsRecipient":{"type":"boolean","description":"Run the export queries as the recipient","title":"Run as recipient"},"attachmentSettings":{"type":"object","properties":{"mergeAttachments":{"type":"boolean","description":"Combines multiple PDF attachments into a single file","title":"Merge attachments"},"zipAttachments":{"type":"boolean","description":"Send attachments as a .zip file","title":"Zip attachments"}},"description":"Export attachment settings","title":"Export attachment settings"},"reportVariant":{"type":"object","properties":{"tagId":{"type":"string","description":"Version tag to export","title":"Version tag ID"}},"description":"Report variant","title":"Report variant"},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}},"description":"Always send the export","title":"Always"},{"type":"object","required":["type","condition"],"properties":{"type":{"type":"string","enum":["workbook"]},"condition":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isEmpty"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"}},"description":"If there's no data","title":"Element is empty"},{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"}},"description":"If there's data","title":"Element is not empty"},{"allOf":[{"type":"object","required":["type","elementId","columnId","op","mode"],"properties":{"type":{"type":"string","enum":["column"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"},"columnId":{"type":"string","description":"ID of the column","title":"Column ID"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNull","IsNotNull","Contains","StartsWith","EndsWith"],"description":"Operator","title":"Operator"},"mode":{"type":"string","enum":["any","all"],"description":"Kind of condition evaluation","title":"Condition check"}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"description":"Boolean value","title":"Boolean value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["integer"]},"value":{"type":"string"}},"description":"Integer value","title":"Integer value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"}],"description":"Column value","title":"Column value"}}}],"description":"If a condition is met","title":"Column meets condition"}]}},"description":"Send the export based on a condition","title":"Workbook condition"}],"description":"Export condition options","title":"Export condition options"},"reportSettings":{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"description":"Boolean value","title":"Boolean value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"description":"Number value","title":"Number value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"}},"description":"Date value","title":"Date value"}],"description":"Scalar value","title":"Scalar value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"allOf":[{"type":"object","required":["true","false"],"properties":{"true":{"type":"boolean"},"false":{"type":"boolean"}}},{"type":"object","properties":{"null":{"type":"boolean"}}}]}},"description":"Boolean list value","title":"Boolean list value"},{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"description":"Number value","title":"Number value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}},"description":"Null number value","title":"Null number value"}]}}},"description":"Number list value","title":"Number list value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}},"description":"Null text value","title":"Null text value"}]}}},"description":"Text list value","title":"Text list value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}]}}},"description":"Date list value","title":"Date list value"}],"description":"List value","title":"List value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["hierarchical-list"]},"value":{"type":"array","items":{"type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"}},"description":"Array of hierarchy paths. Each path is an array of segments, from the highest selected level of the hierarchy down to the lowest selected level of the hierarchy. Each segment is a `{type: \"text\", value: string}` object. For example, a Region/State/City hierarchy control with Oakland selected would be represented as `[[{\"type\":\"text\",\"value\":\"West\"}, {\"type\":\"text\",\"value\":\"California\"}, {\"type\":\"text\",\"value\":\"Oakland\"}]]`","title":"Hierarchy paths"}},"description":"Hierarchical list value","title":"Hierarchical list value"},{"type":"object","required":["type","min","max"],"properties":{"type":{"type":"string","enum":["date-range"]},"min":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"},"max":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"}},"description":"Date range value","title":"Date range value"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"min":{"type":"number","description":"Minimum value of the range","title":"Minimum value"},"max":{"type":"number","description":"Maximum value of the range","title":"Maximum value"}}}],"description":"Number range value","title":"Number range value"},{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}},"description":"Null number value","title":"Null number value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}},"description":"Null text value","title":"Null text value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}},"description":"Null boolean value","title":"Null boolean value"}],"description":"Null value","title":"Null value"}],"description":"Variable value","title":"Variable value","type":"object"},"description":"This object maps control IDs to the values that they should have when exporting the workbook.","title":"Control values"}},"description":"Report settings","title":"Report settings"}},"description":"Configuration settings for the export schedule."},"description":{"type":["string","null"],"description":"Description of the scheduled export"},"suspensionAction":{"type":"string","enum":["pause","resume"],"description":"Action to take on the schedule. Use `pause` to pause the schedule and `resume` to resume the schedule."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["scheduledNotificationId","reportId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"workbookExportSource":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["report"]}}}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"reportSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"reportVariant":{"type":"object","properties":{"tagId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]},"delete":{"summary":"Delete a scheduled export for a report","description":"This endpoint deletes a specific scheduled export from a report. Deleting a schedule prevents any previously configured exports or alerts from being triggered at the scheduled times.\n\n  ### Usage notes\n  - The `reportId` in the path is required to identify the report. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n  - The `scheduleId` in the path is required to specify which schedule to delete. Retrieve the **scheduleId** by calling the [/v2/reports/{reportId}/schedules](https://help.sigmacomputing.com/reference/list-report-schedules) endpoint and using the `scheduledNotificationId` in the response.\n\n  ### Usage scenarios\n  - **Audit operations**: Use this endpoint to remove unnecessary or outdated schedules that are no longer relevant to the report's current use case.\n\n  ### Best practices\n  - Make sure that deleting a given schedule is in compliance with your organization's data governance and operational policies.\n  - Verify the `scheduleId` and `reportId` before making a deletion request to prevent errors.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"scheduleId","schema":{"type":"string","description":"Unique identifier of the schedule.","title":"Schedule ID"},"in":"path","required":true}],"operationId":"deleteReportSchedule","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/send":{"post":{"summary":"Export a report","description":"Export a report to one or more specified destinations or recipients. Supported destinations include Slack channels, Google Drive, cloud storage, and webhooks. Supported recipients include an organization member, team, or email address.\n\nIf you want to download a report PDF instead, see the [/v2/reports/{reportId}/export](https://help.sigmacomputing.com/reference/export-report) endpoint.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- Only PDF exports are supported for reports.\n- This endpoint is rate limited to 100 requests per minute.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true}],"operationId":"sendReport","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["targets","config","attachments"],"properties":{"targets":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["member"]},"userId":{"type":"string"}},"description":"","title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string"}},"description":"","title":"Team"},{"type":"object","required":["type","email"],"properties":{"type":{"type":"string","enum":["email"]},"email":{"type":"string"}},"description":"","title":"Email"},{"type":"object","required":["type","slackConversationId"],"properties":{"type":{"type":"string","enum":["slackChannel"]},"slackConversationId":{"type":"string"}},"description":"","title":"Slack channel"},{"type":"object","required":["type","googleDriveFolderUrl"],"properties":{"type":{"type":"string","enum":["gdrive"]},"googleDriveFolderUrl":{"type":"string"}},"description":"","title":"Google Drive"},{"type":"object","required":["type","cloudExport"],"properties":{"type":{"type":"string","enum":["cloud-export"]},"cloudExport":{"oneOf":[{"type":"object","required":["bq"],"properties":{"bq":{"type":"object","required":["bqDestination"],"properties":{"bqDestination":{"type":"string"}}}}},{"type":"object","required":["sf"],"properties":{"sf":{"type":"object","required":["sfDestination","authorization"],"properties":{"sfDestination":{"type":"string"},"authorization":{"type":"string"}}}}},{"type":"object","required":["rs"],"properties":{"rs":{"type":"object","required":["rsDestination","authorization"],"properties":{"rsDestination":{"type":"string"},"authorization":{"type":"string"}}}}}]}},"description":"","title":"Cloud Storage"},{"type":"object","required":["type","webhookUrl"],"properties":{"type":{"type":"string","enum":["webhook"]},"webhookUrl":{"type":"string"}},"description":"","title":"Webhook"}]}},"config":{"allOf":[{"type":"object","required":["title","messageBody"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"}}}]},"attachments":{"type":"array","items":{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]}}}}}},{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"}},"timeout":{"type":"number"}}}]},"examples":{"Export a report as PDF via email":{"value":{"targets":[{"type":"email","email":"test@example.com"}],"config":{"title":"My report","messageBody":"Please find the report attached.","includeLink":true},"attachments":[{"formatOptions":{"type":"PDF"}}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/sources":{"get":{"summary":"List report sources","description":"Get the data sources of a report given the reportId. The response can be a dataset (deprecated), table, custom SQL element, or the data model document and specific elements used as a source.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n\n### Best practices\n- Validate the **reportId** on the client side before making a request to avoid unnecessary server load caused by invalid requests.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true}],"operationId":"listReportSources","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","dataModelId","elementIds"],"properties":{"type":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string"},"elementIds":{"type":"array","items":{"type":"string"}}}},{"type":"object","properties":{"versionTagId":{"type":"string"}}}],"title":"Data model source"},{"type":"object","required":["type","inodeId"],"properties":{"type":{"type":"string","enum":["dataset"],"description":"Dataset (deprecated)"},"inodeId":{"type":"string"}},"title":"Dataset source (deprecated)"},{"type":"object","required":["type","inodeId"],"properties":{"type":{"type":"string","enum":["table"]},"inodeId":{"type":"string"}},"title":"Table source"},{"type":"object","required":["type","connectionId","definition","customSqlId"],"properties":{"type":{"type":"string","enum":["custom-sql"]},"connectionId":{"type":"string","description":"ID of the connection where the custom SQL element is run."},"definition":{"type":"string","description":"Raw SQL definition for the custom SQL element."},"customSqlId":{"type":"string","description":"Element ID of the custom SQL."}},"title":"Custom SQL element"}]}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/spec":{"get":{"summary":"Get the code representation of a report (Beta)","description":"This endpoint returns a code representation of a report, including metadata and contents. The response can be formatted as either JSON or YAML, and contains the report's pages, elements, columns, sources, and more.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- To create a new report from code, use the [/v2/reports/spec](https://help.sigmacomputing.com/reference/create-report-spec) endpoint.\n- To update an existing report from code, use the [/v2/reports/{reportId}/spec](https://help.sigmacomputing.com/reference/update-report-spec) endpoint.\n- The default format of the representation is YAML. To receive JSON, add the query parameter `?format=json` or the header `Accept: application/json`.\n\n### Usage scenarios\n- **Backup and restore**: Developers can use this endpoint to programmatically back up reports and restore them if needed.\n- **Version control**: Developers can use this endpoint to programmatically manage, update, and version control reports between several organizations or tenants.\n","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"documentVersion","schema":{"type":"integer"},"in":"query"},{"name":"format","schema":{"oneOf":[{"type":"string","enum":["yaml"]},{"type":"string","enum":["yml"]},{"type":"string","enum":["json"]}]},"in":"query"}],"operationId":"getReportSpec","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","required":["reportId"],"properties":{"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"}}},{"type":"object","required":["name","url","documentVersion","latestDocumentVersion","ownerId","folderId","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"name":{"type":"string","description":"The name of the report."},"url":{"type":"string","description":"The full URL for the requested document version of the report."},"documentVersion":{"type":"number","description":"The document version of the report."},"latestDocumentVersion":{"type":"number","description":"The most recently published document version of the report."},"ownerId":{"type":"string","description":"The identifier of the user who owns the report."},"folderId":{"type":"string","description":"The identifier of the folder in which the report is located."},"createdBy":{"type":"string","description":"The identifier of the user who created the report."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated the report."},"createdAt":{"type":"string","format":"date-time","description":"When the report was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the report was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the report."}}}]},{"type":"object","required":["document"],"properties":{"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the report."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["report"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["elements","pages"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/ReportElement"},"description":"The elements that appear on the report's pages and panels."},"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages in the report."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the report panel."},"type":{"oneOf":[{"type":"string","enum":["header"]},{"type":"string","enum":["footer"]}],"description":"The panel type. Either `header` or `footer`."}}},{"type":"object","properties":{"title":{"type":"string","description":"Display title of the panel."},"config":{"type":"object","properties":{"height":{"type":"number","description":"The height of the panel in pixels. Defaults to the report panel height default."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The panel height and background color."},"pages":{"type":"array","items":{"type":"string"},"description":"The identifiers of pages where this panel appears."}}}]},"description":"The header and footer panels in the report."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}}]},{"type":"object","properties":{"config":{"type":"object","properties":{"margin":{"type":"number","description":"Report page margin in pixels."},"pageHeight":{"type":"number","description":"Report page height in pixels."},"pageWidth":{"type":"number","description":"Report page width in pixels."}},"description":"Report-level configuration."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["report"],"description":"Document kind. Always `report` for this resource."}}}]},{"type":"object","required":["layout"],"properties":{"layout":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Pixel layout as XML. Top-level Page and Panel roots; Element children use absolute x/y/width/height in pixels. Panel roots require type=\"header\" or type=\"footer\".","title":"Layout XML"}}}],"description":"The code representation of the report: its pages, elements, columns, sources, layout, and theme. Submit this object as the `document` field of a create or update request to reproduce the report. Everything outside `document` is report metadata that Sigma maintains, and is ignored when you write.","title":"Report Document"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]},"put":{"summary":"Update a report from a code representation (Beta)","description":"This endpoint replaces a report with a report defined in a code representation. This creates a new version of the report, which is accessible from the Sigma UI.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\nFor more information on managing reports programmatically, see [Manage reports as code](https://help.sigmacomputing.com/docs/manage-workbooks-as-code). For more information on using this endpoint, including end-to-end instructions, see [Get the code representation of a report](https://help.sigmacomputing.com/docs/get-the-code-representation-of-a-workbook).\n\n### System and user requirements\n- To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish reports** permission.\n- To perform this operation, you must use API credentials owned by a user with **Can edit** access for the report.\n\n### Usage notes\n- The default format of the representation is YAML. To use JSON, add the header `Content-Type: application/json`.\n- You can define pixel layout using XML in the `layout` field. Top-level `Page` and `Panel` roots may appear together; each `Element` uses absolute `x`/`y`/`width`/`height` attributes in pixels. `Panel` roots require `type=\"header\"` or `type=\"footer\"`. For more information, see [Customize the layout of a report in code representation](https://help.sigmacomputing.com/docs/customize-the-layout-of-a-workbook-in-code-representation).\n- Use the `panels` field for header and footer panel definitions, elements, and page membership (`pages`). Panel pixel placements live in the same `layout` XML as page placements.\n- You can combine multiple YAML documents to create one report representation. For more information, see [Prepare a representation from multiple YAML documents](https://help.sigmacomputing.com/docs/create-a-workbook-from-a-code-representation#prepare-a-representation-from-multiple-yaml-documents).\n- To retrieve the representation of an existing report, use the [/v2/reports/{reportId}/spec](https://help.sigmacomputing.com/reference/get-report-spec) endpoint.\n- To create a new report from code, use the [/v2/reports/spec](https://help.sigmacomputing.com/reference/create-report-spec) endpoint.\n- When `documentVersion` is provided in the request body, the update fails when the report has changed since that version. If omitted, the update preserves last-write-wins behavior.\n- Partial updates are not supported. You must provide the entire representation of the report in the request body.\n\n### Usage scenarios\n- **Agentic workflows**: Agents can use these endpoints to directly manage report contents in code.\n- **Automation**: If you want to update several reports across one or more organizations, or in response to external events, you can use this endpoint to programmatically update the reports.\n- **Integration**: Using this endpoint, you can update reports based on external data sources or integrate Sigma with other tools and platforms.\n","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true}],"operationId":"updateReportSpec","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["document"],"properties":{"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the report."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["report"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["elements","pages"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/ReportElement"},"description":"The elements that appear on the report's pages and panels."},"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages in the report."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the report panel."},"type":{"oneOf":[{"type":"string","enum":["header"]},{"type":"string","enum":["footer"]}],"description":"The panel type. Either `header` or `footer`."}}},{"type":"object","properties":{"title":{"type":"string","description":"Display title of the panel."},"config":{"type":"object","properties":{"height":{"type":"number","description":"The height of the panel in pixels. Defaults to the report panel height default."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The panel height and background color."},"pages":{"type":"array","items":{"type":"string"},"description":"The identifiers of pages where this panel appears."}}}]},"description":"The header and footer panels in the report."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}}]},{"type":"object","properties":{"config":{"type":"object","properties":{"margin":{"type":"number","description":"Report page margin in pixels."},"pageHeight":{"type":"number","description":"Report page height in pixels."},"pageWidth":{"type":"number","description":"Report page width in pixels."}},"description":"Report-level configuration."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["report"],"description":"Document kind. Always `report` for this resource."}}}]},{"type":"object","properties":{"layout":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Pixel layout as XML. Top-level Page and Panel roots; Element children use absolute x/y/width/height in pixels. Panel roots require type=\"header\" or type=\"footer\".","title":"Layout XML"}}}],"description":"The code representation of the report to write: its pages, elements, columns, sources, layout, and theme.","title":"Report Document"}}},{"type":"object","properties":{"documentVersion":{"type":"number","description":"When provided, update only if the report is still at this document version."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["success","reportId"],"properties":{"success":{"type":"boolean"},"reportId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/swapSources":{"post":{"summary":"Swap report data sources","description":"Swap each data source used by a report. You can swap from one table, dataset (deprecated), or data model element to another for each data source.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n- Retrieve report sources by calling the [/v2/reports/{reportId}/sources](https://help.sigmacomputing.com/reference/list-report-sources) endpoint.\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n- Retrieve the **tableId** by calling the [/v2/connection](https://help.sigmacomputing.com/reference/lookup-connection) endpoint.\n\n- Use the `sourceMapping` options in the request body to swap specific sources. For each source in the source mapping, provide the current source in use in the **from** object, and provide the source that you want to use instead in the **to** object.\n- If your source is a data model with one or more tagged versions, you can also provide a `versionTagId` to swap to or from a tagged version of the data model. The data model version must already be tagged.\n- If your source is a data model or a dataset, you can use the `metricMapping` option to map metrics that rely on column names from the old source to the new one so that they continue to work.\n- If the source that you swap from uses column names, links, or relationships different from the source that you are swapping to, use the `columnMapping` option to map each column in the original source to a corresponding column in the new source.\n\n### Usage scenarios\n- **Report development**: Use a test data source during development, then swap to a production source when ready to share the report.\n- **Dataset migration**: Update references to deprecated dataset sources with data model sources by mapping dataset IDs to their new data model equivalents.\n","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true}],"operationId":"sourceSwapReport","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["sourceMapping"],"properties":{"sourceMapping":{"type":"array","items":{"allOf":[{"type":"object","required":["from","to"],"properties":{"from":{"oneOf":[{"type":"object","required":["type","tableId"],"properties":{"type":{"type":"string","enum":["table"]},"tableId":{"type":"string"}},"description":"","title":"Table source"},{"type":"object","required":["type","datasetId"],"properties":{"type":{"type":"string","enum":["dataset"]},"datasetId":{"type":"string"}},"description":"","title":"Dataset source (deprecated)"},{"allOf":[{"type":"object","required":["type","dataModelId","elementId"],"properties":{"type":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string"},"elementId":{"type":"string","description":"ID of the element in the data model","title":"Data model element ID"}}},{"type":"object","properties":{"versionTagId":{"type":"string"}}}],"description":"","title":"Data model source"},{"type":"object","required":["type","customSqlId"],"properties":{"type":{"type":"string","enum":["custom-sql"]},"customSqlId":{"type":"string","description":"ID of the element associated with the custom SQL element.","title":"Custom SQL element ID"}},"description":"","title":"Custom SQL element"}],"description":"Source to swap from.","title":"From data source"},"to":{"oneOf":[{"type":"object","required":["type","tableId"],"properties":{"type":{"type":"string","enum":["table"]},"tableId":{"type":"string"}},"description":"","title":"Table source"},{"type":"object","required":["type","datasetId"],"properties":{"type":{"type":"string","enum":["dataset"]},"datasetId":{"type":"string"}},"description":"","title":"Dataset source (deprecated)"},{"allOf":[{"type":"object","required":["type","dataModelId","elementId"],"properties":{"type":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string"},"elementId":{"type":"string","description":"ID of the element in the data model","title":"Data model element ID"}}},{"type":"object","properties":{"versionTagId":{"type":"string"}}}],"description":"","title":"Data model source"},{"type":"object","required":["type","connectionId","definition"],"properties":{"type":{"type":"string","enum":["custom-sql"]},"connectionId":{"type":"string","description":"ID of the connection that the new custom SQL element will run against.","title":"Connection ID"},"definition":{"type":"string","description":"SQL query that defines the new custom SQL element.","title":"SQL definition"}},"description":"","title":"Custom SQL element"}],"description":"Source to swap to.","title":"To data source"}}},{"type":"object","properties":{"metricMapping":{"type":"array","items":{"type":"object","required":["fromMetricId","toMetricId"],"properties":{"fromMetricId":{"type":"string","description":"Identifier of the metric in the data source","title":"Metric ID"},"toMetricId":{"type":"string","description":"Identifier of the metric in the data source","title":"Metric ID"}}}},"columnMapping":{"type":"array","items":{"type":"object","required":["fromColumn","toColumn"],"properties":{"fromColumn":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Column ID in the form [\"column_id\"]","title":"Column ID"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link in the form [\"link_name\", \"column_name\"]","title":"Link"},{"type":"array","items":{"type":"string"},"description":"Relationship in the form [\"relationship_id\", \"column_name\"]","title":"Relationship"}]},"toColumn":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Column ID in the form [\"column_id\"]","title":"Column ID"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link in the form [\"link_name\", \"column_name\"]","title":"Link"},{"type":"array","items":{"type":"string"},"description":"Relationship in the form [\"relationship_id\", \"column_name\"]","title":"Relationship"}]}}}}}}]}}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/tag/{versionTag}/copy":{"post":{"summary":"Duplicate a tagged report","description":"This endpoint lets you duplicate a tagged report, creating a new report from the tagged version. The report copy can be placed in a different folder from the original report, potentially with a different name and description. This is useful for creating report templates or backups.\n### Usage notes\n- The reportId and version tag in the URL specify the tagged version of the report to duplicate. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint. For the **versionTag**, you can specify either the tag name or ID. Retrieve the version tag name or ID by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint.\n- The `destinationFolderId` in the request body specifies where to place the new report.\n  - To use the \"My Documents\" folder for a specific user as the destination folder, call the [/v2/members/{memberId}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response.\n  - Retrieve the **folderId** of all folders by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n### Best practices\n- Always verify that the destination folder has the correct permissions set to avoid access issues.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"versionTag","schema":{"type":"string","description":"The id or name of the version tag to use.","title":"versionTag"},"in":"path","required":true}],"operationId":"copyTaggedReport","requestBody":{"description":"Body parameters for copying a report.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["destinationFolderId","name"],"properties":{"destinationFolderId":{"type":"string","description":"ID of the folder in which to place the copied report.","title":"Destination Folder ID"},"name":{"type":"string","description":"Name for the copied report as it appears in Sigma.","title":"New Report Name"}}},{"type":"object","properties":{"description":{"type":"string","description":"A description for the new report.","title":"New Description"}}}],"description":"Body parameters for copying a report."}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["reportId","reportUrlId","name","url","path","latestVersion","ownerId"],"properties":{"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"reportUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"allOf":[{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}},{"type":"object","required":["taggedReportId"],"properties":{"taggedReportId":{"type":"string","description":"Unique identifier of the tagged report.","title":"Report ID"}}}]}},"description":{"type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/tags":{"get":{"summary":"List tags for a report","description":"Retrieve the version tag information for a report. Returns the same tag metadata as the [GET /v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint returns for a tagged report.\n  ### Usage notes\n  - Use this endpoint to provide on-demand access to version tag information for a report. For example, call the [GET /v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint with the \"excludeTags\" parameter set to `True` to improve performance, then use this endpoint to return tag information for specific reports.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listReportTags","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}},{"type":"object","required":["taggedReportId"],"properties":{"taggedReportId":{"type":"string","description":"Unique identifier of the tagged report.","title":"Report ID"}}}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/tags/{tagId}":{"delete":{"summary":"Remove a tag from a report","description":"This endpoint allows you to remove outdated or unnecessary version tags from a report.\n\n  ### Usage notes\n  - **reportId:** The unique identifier for the report to remove the tag from. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n  - **tagId:** The unique identifier for the tag to remove. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.\n\n  ### Usage scenarios\n  - **Organizational updates:** Useful for administrators who need to update tagging schemes as project requirements change.\n  - **Data management:** Ensures report metadata is relevant and current for easier access and identification.\n\n  ### Best practices\n  - Verify that the correct tag is being removed by reviewing its associated reports and the implications of its removal.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"tagId","schema":{"type":"string","description":"Unique identifier of the version tag.","title":"Tag ID"},"in":"path","required":true}],"operationId":"deleteTaggedReport","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/{reportId}/version-history":{"get":{"summary":"Get version history for a report","description":"Get version history for a report given the reportId. If the version history contains any tagged versions, the response includes information about those tags.\n\n### Usage notes\n- Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n\n### Usage scenarios\n- **Audit and compliance**: Demonstrate the history of changes to a report for audit and compliance purposes.\n- **Restoring previous versions**: Locate a prior version to compare against or restore after an unwanted change.\n\n### Best practices\n- Validate the **reportId** before making a request to avoid invalid requests.","parameters":[{"name":"reportId","schema":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"getReportVersionHistory","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["version","publishedAt","publishedBy"],"properties":{"version":{"type":"number"},"publishedAt":{"type":"string","format":"date-time"},"publishedBy":{"type":"string"}}},{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","required":["versionTagId","taggedAt","taggedBy"],"properties":{"versionTagId":{"type":"string"},"taggedAt":{"type":"string","format":"date-time"},"taggedBy":{"type":"string"}}}}}}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/spec":{"post":{"summary":"Create a report from a code representation (Beta)","description":"This endpoint creates a new report from a code representation. Use it to programmatically define and create reports that are then accessible from the Sigma UI.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To retrieve the representation of an existing report, use the [/v2/reports/{reportId}/spec](https://help.sigmacomputing.com/reference/get-report-spec) endpoint.\n- To update an existing report from code, use the [/v2/reports/{reportId}/spec](https://help.sigmacomputing.com/reference/update-report-spec) endpoint.\n- To get a list of folders, call the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and review the `id` field in the response for files with a `type` of `folder`.\n\n### Usage scenarios\n- **Agentic workflows**: Agents can use these endpoints to directly manage report contents in code.\n- **Automation**: If you want to create several reports across one or more organizations, you can use this endpoint to programmatically create the reports.\n- **Integration**: Using this endpoint, you can create reports based on external data sources or integrate Sigma with other tools and platforms.\n- **Migration**: You can use this endpoint to migrate reports from one organization to another.\n","parameters":[],"operationId":"createReportSpec","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name","folderId","document"],"properties":{"name":{"type":"string","description":"The name of the report."},"folderId":{"type":"string","description":"The identifier of the folder in which the report is located."},"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the report."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["report"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["elements","pages"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/ReportElement"},"description":"The elements that appear on the report's pages and panels."},"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages in the report."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the report panel."},"type":{"oneOf":[{"type":"string","enum":["header"]},{"type":"string","enum":["footer"]}],"description":"The panel type. Either `header` or `footer`."}}},{"type":"object","properties":{"title":{"type":"string","description":"Display title of the panel."},"config":{"type":"object","properties":{"height":{"type":"number","description":"The height of the panel in pixels. Defaults to the report panel height default."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The panel height and background color."},"pages":{"type":"array","items":{"type":"string"},"description":"The identifiers of pages where this panel appears."}}}]},"description":"The header and footer panels in the report."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}}]},{"type":"object","properties":{"config":{"type":"object","properties":{"margin":{"type":"number","description":"Report page margin in pixels."},"pageHeight":{"type":"number","description":"Report page height in pixels."},"pageWidth":{"type":"number","description":"Report page width in pixels."}},"description":"Report-level configuration."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["report"],"description":"Document kind. Always `report` for this resource."}}}]},{"type":"object","properties":{"layout":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Pixel layout as XML. Top-level Page and Panel roots; Element children use absolute x/y/width/height in pixels. Panel roots require type=\"header\" or type=\"footer\".","title":"Layout XML"}}}],"description":"The code representation of the report to write: its pages, elements, columns, sources, layout, and theme.","title":"Report Document"}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the report."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["success","reportId"],"properties":{"success":{"type":"boolean"},"reportId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/spec/verify":{"post":{"summary":"Verify a report code representation (Beta)","description":"This endpoint validates a report code representation without creating or modifying any report. It performs the same validation as the [/v2/reports/spec](https://help.sigmacomputing.com/reference/create-report-spec) endpoint but never persists the result, so you can confirm a representation is valid before creating a report from it.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### System and user requirements\n- To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish reports** permission.\n\n### Usage notes\n- The response `valid` field indicates whether the representation passed validation. When `valid` is `false`, the `errors` array describes each validation failure.\n- The request body is identical to the [/v2/reports/spec](https://help.sigmacomputing.com/reference/create-report-spec) endpoint.\n- No report is created and no data is persisted by this endpoint.\n\n### Usage scenarios\n- **Agentic workflows**: Agents can validate a generated representation before committing it to a create or update operation.\n- **Automation**: Validate representations in CI or migration tooling before applying them.\n","parameters":[],"operationId":"verifyReportSpec","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name","folderId","document"],"properties":{"name":{"type":"string","description":"The name of the report."},"folderId":{"type":"string","description":"The identifier of the folder in which the report is located."},"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the report."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["report"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["elements","pages"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/ReportElement"},"description":"The elements that appear on the report's pages and panels."},"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages in the report."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the report panel."},"type":{"oneOf":[{"type":"string","enum":["header"]},{"type":"string","enum":["footer"]}],"description":"The panel type. Either `header` or `footer`."}}},{"type":"object","properties":{"title":{"type":"string","description":"Display title of the panel."},"config":{"type":"object","properties":{"height":{"type":"number","description":"The height of the panel in pixels. Defaults to the report panel height default."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The panel height and background color."},"pages":{"type":"array","items":{"type":"string"},"description":"The identifiers of pages where this panel appears."}}}]},"description":"The header and footer panels in the report."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}}]},{"type":"object","properties":{"config":{"type":"object","properties":{"margin":{"type":"number","description":"Report page margin in pixels."},"pageHeight":{"type":"number","description":"Report page height in pixels."},"pageWidth":{"type":"number","description":"Report page width in pixels."}},"description":"Report-level configuration."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["report"],"description":"Document kind. Always `report` for this resource."}}}]},{"type":"object","properties":{"layout":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Pixel layout as XML. Top-level Page and Panel roots; Element children use absolute x/y/width/height in pixels. Panel roots require type=\"header\" or type=\"footer\".","title":"Layout XML"}}}],"description":"The code representation of the report to write: its pages, elements, columns, sources, layout, and theme.","title":"Report Document"}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the report."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["valid"],"properties":{"valid":{"type":"boolean","enum":[true],"description":"The report code representation passed validation."}},"description":"A valid report code representation."},{"type":"object","required":["valid","errors"],"properties":{"valid":{"type":"boolean","enum":[false],"description":"The report code representation failed validation."},"errors":{"type":"array","items":{"type":"object","required":["summary"],"properties":{"summary":{"type":"string","description":"A human-readable description of a validation failure."}}},"description":"The validation failures found in the code representation."}},"description":"An invalid report code representation, with the validation failures."}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/reports/tag":{"post":{"summary":"Tag a report","description":"Add a version tag to a report and optionally set up a connection to swap to for a specific version of the report.\n\n  ### Usage notes\n  - Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.\n  - Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n  - Retrieve the **connectionId** to use as the **fromId** or **toId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - If your report includes a source that is not mapped to a new source, that source is not swapped.\n  - When swapping data models used as the source for the report:\n    - You can only swap a data model source to another version of the same data model source. You cannot swap a data model source to a table in your data warehouse or a dataset.\n    - When you swap sources from one data model version to a new one, specify the version tag of the data model that you swap to with `toVersionTagId`:\n      - To swap to the latest published version of the data model, specify `toVersionTagId` as `null`.\n      - To swap to a specific tagged version of the data model, specify the `toVersionTagId` of the data model.\n    - If the report already uses a specific tagged version of a data model as a source, use `fromVersionTagId` to indicate which tagged version to swap from.\n      - To swap from the latest published version of the data model, specify `fromVersionTagId` as `null`.\n      - To swap from a specific tagged version of the data model, specify the `fromVersionTagId` of the data model.\n  - To retrieve the `fromVersionTagId` for a data model used as the report source, call the [/v2/reports/{reportId}/sources](https://help.sigmacomputing.com/reference/list-report-sources) endpoint and use the `versionTagId` in the response.\n  - To retrieve the `versionTagId` for a data model, call the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint and use the `versionTagId` in the response.\n\n  ### Usage scenarios\n  - **Lifecycle management**: Identify production and development resources.\n    ","parameters":[],"operationId":"tagReport","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["reportId","tagName"],"properties":{"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"tagName":{"type":"string","description":"Name of the version tag to apply.","title":"Version tag name"}}},{"type":"object","properties":{"reportVersion":{"type":"number","description":"Specific version of the published report to tag."},"sourceMappingConfig":{"type":"array","items":{"type":"object","required":["fromConnectionId","toConnectionId","paths"],"properties":{"fromConnectionId":{"type":"string"},"toConnectionId":{"type":"string"},"paths":{"type":"array","items":{"type":"object","required":["fromPath","toPath"],"properties":{"fromPath":{"type":"array","items":{"type":"string"}},"toPath":{"type":"array","items":{"type":"string"}}}}}}},"description":"Swap sources for the report when you add a tag."},"dataModelSourceTaggedVersions":{"type":"array","items":{"type":"object","required":["dataModelId","fromVersionTagId","toVersionTagId"],"properties":{"dataModelId":{"type":"string"},"fromVersionTagId":{"type":["string","null"]},"toVersionTagId":{"type":["string","null"]}}},"description":"Which tagged version of the data model to use as the source."},"isDefault":{"type":"boolean","description":"Whether to make this tag the default tagged version to load if the user doesn't have access to the published version."}}}]},"examples":{"Request Example":{"value":{"reportId":"00000000-0000-0000-0000-000000000000","reportVersion":4,"tagName":"production","sourceMappingConfig":[{"fromConnectionId":"00000000-0000-0000-0000-000000000000","toConnectionId":"00000000-0000-0000-0000-000000000001","paths":[{"fromPath":["SNOWFLAKE_DEVELOPMENT","WEATHER","DAILY_14_TOTAL"],"toPath":["SNOWFLAKE_PRODUCTION","WEATHER","DAILY_16_TOTAL"]}]}],"isDefault":true}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["versionTagId","taggedReportId","taggedReportVersion"],"properties":{"versionTagId":{"type":"string"},"taggedReportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"taggedReportVersion":{"type":"number"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["reports"]}},"/v2/saml/service-providers":{"get":{"summary":"List SAML service providers (Beta)","description":"List all SAML service providers in the organization.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 500. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listSamlServiceProviders","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["samlServiceProviderId"],"properties":{"samlServiceProviderId":{"type":"string","description":"Unique identifier of the SAML service provider"}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["saml"]}},"/v2/saml/service-providers/{samlServiceProviderId}/certificates":{"get":{"summary":"List SAML service provider certificates (Beta)","description":"List all certificates for a given SAML service provider.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](https://help.sigmacomputing.com/reference/list-saml-service-providers) endpoint.","parameters":[{"name":"samlServiceProviderId","schema":{"type":"string","description":"Unique identifier of the SAML service provider"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 500. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listSamlServiceProviderCertificates","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["samlServiceProviderCertificateId","samlServiceProviderId","purpose","publicKeyCertificate","isActive","notBefore","notAfter","createdAt","createdBy","updatedAt","updatedBy"],"properties":{"samlServiceProviderCertificateId":{"type":"string","description":"Unique identifier of the SAML service provider certificate"},"samlServiceProviderId":{"type":"string","description":"Unique identifier of the SAML service provider"},"purpose":{"type":"string","enum":["signing","encryption"],"description":"Purpose of the certificate. Use `signing` for signing SAML requests and `encryption` for encrypting SAML responses."},"publicKeyCertificate":{"type":"string","description":"PEM-encoded X.509 certificate"},"isActive":{"type":"boolean","description":"Whether the certificate is currently active"},"notBefore":{"type":"string","format":"date-time","description":"Date and time when the certificate becomes valid"},"notAfter":{"type":"string","format":"date-time","description":"Date and time when the certificate expires"},"createdAt":{"type":"string","format":"date-time","description":"When the certificate was created"},"createdBy":{"type":"string","description":"Identifier of the user who created the certificate"},"updatedAt":{"type":"string","format":"date-time","description":"When the certificate was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the certificate"}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["saml"]},"post":{"summary":"Create a SAML service provider certificate (Beta)","description":"Create a certificate for a given SAML service provider.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](https://help.sigmacomputing.com/reference/list-saml-service-providers) endpoint.","parameters":[{"name":"samlServiceProviderId","schema":{"type":"string","description":"Unique identifier of the SAML service provider"},"in":"path","required":true}],"operationId":"createSamlServiceProviderCertificate","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["purpose","validForDays"],"properties":{"purpose":{"type":"string","enum":["signing","encryption"],"description":"Purpose of the certificate. Use `signing` for signing SAML requests and `encryption` for encrypting SAML responses."},"validForDays":{"type":"number","description":"Number of days the certificate is valid"}}}}}},"responses":{"201":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["samlServiceProviderId","samlServiceProviderCertificateId"],"properties":{"samlServiceProviderId":{"type":"string","description":"Unique identifier of the SAML service provider"},"samlServiceProviderCertificateId":{"type":"string","description":"Unique identifier of the SAML service provider certificate"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["saml"]}},"/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}":{"get":{"summary":"Get a SAML service provider certificate (Beta)","description":"Get a certificate to use with your IdP when configuring Sigma as a service provider.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](https://help.sigmacomputing.com/reference/list-saml-service-providers) endpoint.\n- Retrieve the `samlServiceProviderCertificateId` by calling the [/saml/service-providers/certificates](https://help.sigmacomputing.com/reference/list-saml-service-provider-certificates) endpoint.\n- Signing certificates are used by your IdP to verify signatures that Sigma attaches to SAML requests.\n- Encryption certificates are used by your IdP to encrypt SAML responses sent to Sigma.\n    ","parameters":[{"name":"samlServiceProviderId","schema":{"type":"string","description":"Unique identifier of the SAML service provider"},"in":"path","required":true},{"name":"samlServiceProviderCertificateId","schema":{"type":"string","description":"Unique identifier of the SAML service provider certificate"},"in":"path","required":true}],"operationId":"getSamlServiceProviderCertificate","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["samlServiceProviderCertificateId","samlServiceProviderId","purpose","publicKeyCertificate","isActive","notBefore","notAfter","createdAt","createdBy","updatedAt","updatedBy"],"properties":{"samlServiceProviderCertificateId":{"type":"string","description":"Unique identifier of the SAML service provider certificate"},"samlServiceProviderId":{"type":"string","description":"Unique identifier of the SAML service provider"},"purpose":{"type":"string","enum":["signing","encryption"],"description":"Purpose of the certificate. Use `signing` for signing SAML requests and `encryption` for encrypting SAML responses."},"publicKeyCertificate":{"type":"string","description":"PEM-encoded X.509 certificate"},"isActive":{"type":"boolean","description":"Whether the certificate is currently active"},"notBefore":{"type":"string","format":"date-time","description":"Date and time when the certificate becomes valid"},"notAfter":{"type":"string","format":"date-time","description":"Date and time when the certificate expires"},"createdAt":{"type":"string","format":"date-time","description":"When the certificate was created"},"createdBy":{"type":"string","description":"Identifier of the user who created the certificate"},"updatedAt":{"type":"string","format":"date-time","description":"When the certificate was last updated"},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the certificate"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["saml"]},"delete":{"summary":"Remove a SAML service provider certificate (Beta)","description":"Remove a certificate.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](https://help.sigmacomputing.com/reference/list-saml-service-providers) endpoint.\n- Retrieve the `samlServiceProviderCertificateId` by calling the [/saml/service-providers/certificates](https://help.sigmacomputing.com/reference/list-saml-service-provider-certificates) endpoint.","parameters":[{"name":"samlServiceProviderId","schema":{"type":"string","description":"Unique identifier of the SAML service provider"},"in":"path","required":true},{"name":"samlServiceProviderCertificateId","schema":{"type":"string","description":"Unique identifier of the SAML service provider certificate"},"in":"path","required":true}],"operationId":"removeSamlServiceProviderCertificate","responses":{"204":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["saml"]}},"/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}/activate":{"post":{"summary":"Activate a SAML service provider certificate (Beta)","description":"Activate a certificate.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Activating a certificate deactivates all certificates used for the same purpose by the same SAML service provider. For example, activating a signing certificate deactivates all other signing certificates in use by the same SAML SP.\n- Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](https://help.sigmacomputing.com/reference/list-saml-service-providers) endpoint.\n- Retrieve the `samlServiceProviderCertificateId` by calling the [/saml/service-providers/certificates](https://help.sigmacomputing.com/reference/list-saml-service-provider-certificates) endpoint.","parameters":[{"name":"samlServiceProviderId","schema":{"type":"string","description":"Unique identifier of the SAML service provider"},"in":"path","required":true},{"name":"samlServiceProviderCertificateId","schema":{"type":"string","description":"Unique identifier of the SAML service provider certificate"},"in":"path","required":true}],"operationId":"activateSamlServiceProviderCertificate","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"204":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["saml"]}},"/v2/saml/service-providers/{samlServiceProviderId}/certificates/{samlServiceProviderCertificateId}/deactivate":{"post":{"summary":"Deactivate a SAML service provider certificate (Beta)","description":"Deactivate a certificate.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the `samlServiceProviderId` by calling the [/saml/service-providers](https://help.sigmacomputing.com/reference/list-saml-service-providers) endpoint.\n- Retrieve the `samlServiceProviderCertificateId` by calling the [/saml/service-providers/certificates](https://help.sigmacomputing.com/reference/list-saml-service-provider-certificates) endpoint.","parameters":[{"name":"samlServiceProviderId","schema":{"type":"string","description":"Unique identifier of the SAML service provider"},"in":"path","required":true},{"name":"samlServiceProviderCertificateId","schema":{"type":"string","description":"Unique identifier of the SAML service provider certificate"},"in":"path","required":true}],"operationId":"deactivateSamlServiceProviderCertificate","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"204":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["saml"]}},"/v2/shared_templates/{shareId}":{"delete":{"summary":"Delete a template share","description":"Remove a template shared with your organization.\n\n  **Usage notes**\n  - Retrieve the **shareId** by calling the [/v2/shared_templates/shared_with_you](https://help.sigmacomputing.com/reference/list-templates-shared-with-you) endpoint and using the `shareId` included in the response.\n  ","parameters":[{"name":"shareId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteExternalShare","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["shared_templates"]}},"/v2/shared_templates/accept":{"post":{"summary":"Accept a pending template share","description":"If a workbook template has been shared with your organization but not yet accepted, accept the template share.\n  \n  ### Usage notes\n  - Retrieve pending template shares by calling the [/v2/shared_templates/shared_with_you](https://help.sigmacomputing.com/reference/list-templates-shared-with-you) endpoint and specifying `pending` as `true`.\n  - Retrieve the **shareId** by calling the [/v2/shared_templates/shared_with_you](https://help.sigmacomputing.com/reference/list-templates-shared-with-you) endpoint and using the `shareId` included in the response.\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - Retrieve the **inodeId** for a table by calling the [/v2/connections/{connectionId}/lookup](https://help.sigmacomputing.com/reference/lookup-connection) endpoint.\n\n  - The key of the **sourceSwaps** object is the original id of the table, dataset, or connection in the organization that shared the template\n  ","parameters":[],"operationId":"acceptTemplateShare","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["shareId"],"properties":{"shareId":{"type":"string"}}},{"type":"object","properties":{"sourceSwaps":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","newInodeId","columns","metrics"],"properties":{"type":{"type":"string","enum":["table"]},"newInodeId":{"type":"string"},"columns":{"type":"object","additionalProperties":{"type":"string"},"description":"Mapping from old column names to new column names. Leave blank to keep the same column names."},"metrics":{"type":"object","additionalProperties":{"type":"string"},"description":"Mapping from old metric names to new metric names. Leave blank to keep the same metric names."}},"description":"","title":"Table swap"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["connection"]}}},{"oneOf":[{"type":"object","required":["newConnectionId"],"properties":{"newConnectionId":{"type":"string"}}},{"type":"object","required":["newConnectionName"],"properties":{"newConnectionName":{"type":"string"}}}]}],"description":"","title":"Connection swap"}],"description":"","title":"Old source id","type":"object"},"description":"","title":"Source swaps"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["shared_templates"]}},"/v2/shared_templates/shared_with_you":{"get":{"summary":"List templates shared with your organization","description":"Lists all workbook templates shared with your organization.\n  \n  ### Usage notes\n  - Use the `pending` parameter to identify templates that have been shared but not yet accepted.\n  ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"pending","schema":{"type":"boolean"},"in":"query"}],"operationId":"listTemplatesSharedWithYou","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["providerOrganizationId","name","shareId","createdAt"],"properties":{"providerOrganizationId":{"type":"string"},"name":{"type":"string"},"shareId":{"type":"string"},"createdAt":{"type":"string","format":"date-time","description":"When the template was shared with your organization."}}},{"type":"object","properties":{"description":{"type":"string"},"pending":{"type":"boolean"}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["shared_templates"]}},"/v2/shortcuts":{"post":{"summary":"Create a shortcut","description":"Create a shortcut that surfaces an existing item in another folder or workspace without duplicating it.\n\n  ### Usage notes\n  - A shortcut requires a **parentId** (the folder or workspace to place it in) and a **target** (the item the shortcut points to).\n    - Retrieve the ID of a folder to use as a **parentId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n    - Retrieve the ID of a workspace to use as a **parentId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.\n  - The target can be a document (workbook, data model, report, dataset, or folder) or a database object (table, view, schema, database, or stored procedure).\n  - You must have at least **Can view** access to the target document or folder, or **Can use** access to the target database object.\n\n  ### Usage scenarios\n  - **Deployment and embedding**: Surface shared workbooks or data models in tenant workspaces or folders without exposing a central workspace to end users.\n    ","parameters":[],"operationId":"shortcutsCreate","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["parentId","target"],"properties":{"parentId":{"type":"string","description":"The ID of the folder or workspace to place the shortcut in.","title":"Parent folder"},"target":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the workbook, data model, report, dataset, folder, or database object the shortcut points to.","title":"Shortcut target ID"}},"description":"The item the shortcut points to.","title":"Shortcut target"}}},{"type":"object","properties":{"name":{"type":"string","description":"A name for the shortcut. Defaults to the name of the item it points to if this field is omitted.","title":"Shortcut name"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["id","urlId","name","parentId","parentUrlId","path","target"],"properties":{"id":{"type":"string"},"urlId":{"type":"string"},"name":{"type":"string"},"parentId":{"type":"string"},"parentUrlId":{"type":"string"},"path":{"type":"string"},"target":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["workbook","data-model","dataset","report","folder","table","scope","stored-procedure"],"description":"The type of the item this shortcut points to. For database targets, `table` also covers views, and `scope` covers schemas and databases.","title":"Shortcut target type"},"id":{"type":"string","description":"The ID of the item this shortcut points to.","title":"Shortcut target ID"}}}}},{"type":"object","properties":{"ownerId":{"type":["string","null"]}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["shortcuts"]}},"/v2/sourceSwapPolicies":{"post":{"summary":"Create a source swap policy","description":"Create a source swap policy.\n\n  **Beta**: Creating a **Connection** source swap policy is in private beta and must be enabled for your organization. This documentation is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **connectionId** to use as the **fromConnectionId** by calling the [/v2/connections](/reference/list-connections) endpoint.\n  - Retrieve the **userAttributeId** to use in the **swaps** object by calling the [/v2/user-attributes](/reference/list-user-attributes) endpoint.\n  ","parameters":[],"operationId":"createSourceSwapPolicy","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["type","name","fromConnectionId","swaps"],"properties":{"type":{"type":"string","enum":["connection"]},"name":{"type":"string","description":"Name of the source swap policy."},"fromConnectionId":{"type":"string","description":"ID of the connection to swap."},"swaps":{"type":"object","required":["connectionSwaps"],"properties":{"connectionSwaps":{"type":"array","items":{"type":"object","required":["to"],"properties":{"to":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."},"path1":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}}],"description":"Specify how to swap each segment of a path to a table in your database, catalog, or project. `path0` is equivalent to a database, catalog, or project. `path` is equivalent to a schema or dataset, and `path2` is equivalent to a table or view."}}},"description":"Swap paths to a different location in the same connection."}},"description":"","title":"Swap rules"}},"description":"","title":"Connection swap"},{"type":"object","required":["type","name","fromConnectionId","swaps"],"properties":{"type":{"type":"string","enum":["deployment"]},"name":{"type":"string","description":"Name of the source swap policy."},"fromConnectionId":{"type":"string","description":"ID of the connection to swap."},"swaps":{"type":"object","required":["toConnection","deploymentSwaps"],"properties":{"toConnection":{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},"deploymentSwaps":{"type":"array","items":{"type":"object","required":["from","to"],"properties":{"from":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]},"path1":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]}}}]},"to":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."},"path1":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}}]}}}}},"description":"","title":"Swap rules"}},"description":"","title":"Deployment swap"}]},"examples":{"Swap tenant connections":{"value":{"type":"deployment","name":"Tenant Snowflake Swap","fromConnectionId":"9f2a6b1e-4c3d-4a8f-9e21-6d7c8b3a51f0","swaps":{"toConnection":{"swapType":"attribute","userAttributeId":"e4b7c2a1-9d3f-4e6b-8a2c-5f1d9e3b7a4c"},"deploymentSwaps":[]}}},"Swap a specific database path":{"value":{"type":"deployment","name":"Tenant Snowflake Swap - Finance Schema","fromConnectionId":"9f2a6b1e-4c3d-4a8f-9e21-6d7c8b3a51f0","swaps":{"toConnection":{"swapType":"attribute","userAttributeId":"e4b7c2a1-9d3f-4e6b-8a2c-5f1d9e3b7a4c"},"deploymentSwaps":[{"from":{"path0":{"swapType":"exact","catalogObject":"FIN_OPS"},"path1":{"swapType":"all"}},"to":{"path0":{"swapType":"attribute","userAttributeId":"8b3d5c1e-2a6f-4a9b-8d3f-9f1c4a7e2b6d"},"path1":{"swapType":"all"}}}]}}}}}}},"responses":{"200":{"description":"Source Swap Policy Response","content":{"application/json":{"schema":{"type":"object","required":["policyId"],"properties":{"policyId":{"type":"string","description":"Unique identifier of the source swap policy."}},"description":"Source Swap Policy Response"},"examples":{"Swap tenant connections":{"value":{"policyId":"2a6f8b3d-5c1e-4a9b-8d3f-7e2c4b6a9f1d"}},"Swap a specific database path":{"value":{"policyId":"6f1a3c7e-8d2b-4e9f-9a5c-2b6d4f8a1e3c"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["sourceSwapPolicies"]},"get":{"summary":"List source swap policies","description":"Get a list of source swap policies.\n\n  **Beta**: Getting a list of **Connection** source swap policies is in private beta and must be enabled for your organization. This documentation is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n    ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listSourceSwapPolicies","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"oneOf":[{"type":"object","required":["type","name","fromConnectionId","swaps"],"properties":{"type":{"type":"string","enum":["connection"]},"name":{"type":"string","description":"Name of the source swap policy."},"fromConnectionId":{"type":"string","description":"ID of the connection to swap."},"swaps":{"type":"object","required":["connectionSwaps"],"properties":{"connectionSwaps":{"type":"array","items":{"type":"object","required":["to"],"properties":{"to":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."},"path1":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}}],"description":"Specify how to swap each segment of a path to a table in your database, catalog, or project. `path0` is equivalent to a database, catalog, or project. `path` is equivalent to a schema or dataset, and `path2` is equivalent to a table or view."}}},"description":"Swap paths to a different location in the same connection."}},"description":"","title":"Swap rules"}},"description":"","title":"Connection swap"},{"type":"object","required":["type","name","fromConnectionId","swaps"],"properties":{"type":{"type":"string","enum":["deployment"]},"name":{"type":"string","description":"Name of the source swap policy."},"fromConnectionId":{"type":"string","description":"ID of the connection to swap."},"swaps":{"type":"object","required":["toConnection","deploymentSwaps"],"properties":{"toConnection":{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},"deploymentSwaps":{"type":"array","items":{"type":"object","required":["from","to"],"properties":{"from":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]},"path1":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]}}}]},"to":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."},"path1":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}}]}}}}},"description":"","title":"Swap rules"}},"description":"","title":"Deployment swap"}]},{"type":"object","required":["policyId"],"properties":{"policyId":{"type":"string"}}}],"description":"Get source swap policy response"}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["sourceSwapPolicies"]}},"/v2/sourceSwapPolicies/{policyId}":{"patch":{"summary":"Update a source swap policy","description":"Update a source swap policy.\n\n  **Beta**: Updating a **Connection** source swap policy is in private beta and must be enabled for your organization. This documentation is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **policyId** by calling the [/v2/sourceSwapPolicies](https://help.sigmacomputing.com/reference/list-source-swap-policies) endpoint.\n  - Retrieve the **connectionId** to use as the **fromConnectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - Retrieve the **userAttributeId** to use in the **swaps** object by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n    ","parameters":[{"name":"policyId","schema":{"type":"string","description":"Id of the source swap policy."},"in":"path","required":true}],"operationId":"updateSourceSwapPolicy","requestBody":{"description":"Update source swap policy request","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["connection"]},"name":{"type":"string","description":"Name of the source swap policy."},"fromConnectionId":{"type":"string","description":"ID of the connection to swap."},"swaps":{"type":"object","required":["connectionSwaps"],"properties":{"connectionSwaps":{"type":"array","items":{"type":"object","required":["to"],"properties":{"to":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."},"path1":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}}],"description":"Specify how to swap each segment of a path to a table in your database, catalog, or project. `path0` is equivalent to a database, catalog, or project. `path` is equivalent to a schema or dataset, and `path2` is equivalent to a table or view."}}},"description":"Swap paths to a different location in the same connection."}},"description":"","title":"Swap rules"}},"description":"Connection swap policy"},{"type":"object","properties":{"type":{"type":"string","enum":["deployment"]},"name":{"type":"string","description":"Name of the source swap policy."},"fromConnectionId":{"type":"string","description":"ID of the connection to swap."},"swaps":{"type":"object","required":["toConnection","deploymentSwaps"],"properties":{"toConnection":{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},"deploymentSwaps":{"type":"array","items":{"type":"object","required":["from","to"],"properties":{"from":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]},"path1":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]}}}]},"to":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."},"path1":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}}]}}}}},"description":"","title":"Swap rules"}},"description":"Deployment swap policy"}],"description":"Update source swap policy request"}}}},"responses":{"200":{"description":"Source Swap Policy Response","content":{"application/json":{"schema":{"type":"object","required":["policyId"],"properties":{"policyId":{"type":"string","description":"Unique identifier of the source swap policy."}},"description":"Source Swap Policy Response"}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["sourceSwapPolicies"]},"delete":{"summary":"Delete a source swap policy","description":"Delete a source swap policy by policy ID.\n\n  **Beta**: Deleting a **Connection** source swap policy is in private beta and must be enabled for your organization. This documentation is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **policyId** by calling the [/v2/sourceSwapPolicies](https://help.sigmacomputing.com/reference/list-source-swap-policies) endpoint.\n    ","parameters":[{"name":"policyId","schema":{"type":"string","description":"Id of the source swap policy."},"in":"path","required":true}],"operationId":"deleteSourceSwapPolicy","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["sourceSwapPolicies"]},"get":{"summary":"Get a source swap policy","description":"Get a source swap policy by policy ID.\n\n  **Beta**: Getting details for a **Connection** source swap policy is in private beta and must be enabled for your organization. This documentation is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **policyId** by calling the [/v2/sourceSwapPolicies](https://help.sigmacomputing.com/reference/list-source-swap-policies) endpoint.\n    ","parameters":[{"name":"policyId","schema":{"type":"string","description":"Id of the source swap policy."},"in":"path","required":true}],"operationId":"getSourceSwapPolicy","responses":{"200":{"description":"Get source swap policy response","content":{"application/json":{"schema":{"allOf":[{"oneOf":[{"type":"object","required":["type","name","fromConnectionId","swaps"],"properties":{"type":{"type":"string","enum":["connection"]},"name":{"type":"string","description":"Name of the source swap policy."},"fromConnectionId":{"type":"string","description":"ID of the connection to swap."},"swaps":{"type":"object","required":["connectionSwaps"],"properties":{"connectionSwaps":{"type":"array","items":{"type":"object","required":["to"],"properties":{"to":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."},"path1":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}}],"description":"Specify how to swap each segment of a path to a table in your database, catalog, or project. `path0` is equivalent to a database, catalog, or project. `path` is equivalent to a schema or dataset, and `path2` is equivalent to a table or view."}}},"description":"Swap paths to a different location in the same connection."}},"description":"","title":"Swap rules"}},"description":"","title":"Connection swap"},{"type":"object","required":["type","name","fromConnectionId","swaps"],"properties":{"type":{"type":"string","enum":["deployment"]},"name":{"type":"string","description":"Name of the source swap policy."},"fromConnectionId":{"type":"string","description":"ID of the connection to swap."},"swaps":{"type":"object","required":["toConnection","deploymentSwaps"],"properties":{"toConnection":{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},"deploymentSwaps":{"type":"array","items":{"type":"object","required":["from","to"],"properties":{"from":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]},"path1":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"}]}}}]},"to":{"allOf":[{"type":"object","required":["path0","path1"],"properties":{"path0":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."},"path1":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}},{"type":"object","properties":{"path2":{"oneOf":[{"type":"object","required":["swapType","userAttributeId"],"properties":{"swapType":{"type":"string","enum":["attribute"],"description":"Specify a user attribute to use the value of the user attribute as the value to swap."},"userAttributeId":{"type":"string"}},"description":"","title":"User attribute"},{"type":"object","required":["swapType","catalogObject"],"properties":{"swapType":{"type":"string","enum":["exact"],"description":"Specify the value in the path to swap to"},"catalogObject":{"type":"string"}},"description":"","title":"Specific path"},{"type":"object","required":["swapType"],"properties":{"swapType":{"type":"string","enum":["all"],"description":"Keep the current path value."}},"description":"","title":"No changes"}],"description":"The rule used to update this specific path value when the swap is performed. If the specified path (when resolved) does not exist, the swap is not performed."}}}]}}}}},"description":"","title":"Swap rules"}},"description":"","title":"Deployment swap"}]},{"type":"object","required":["policyId"],"properties":{"policyId":{"type":"string"}}}],"description":"Get source swap policy response"}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["sourceSwapPolicies"]}},"/v2/tags":{"post":{"summary":"Create a tag","description":"Create a version tag to use, for example, for workbooks.","parameters":[],"operationId":"createVersionTag","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"Name of the tag. Must be unique"},"color":{"type":"string","enum":["cyan","grass","violet","plum","amber","bronze"],"description":"Color to associate with the tag in Sigma"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description for the tag"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["name","versionTagId"],"properties":{"name":{"type":"string"},"versionTagId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tags"]},"get":{"summary":"Get tags","description":"Get a list of version tags.","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"search","schema":{"type":"string","description":"Search query"},"in":"query"}],"operationId":"listVersionTag","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["versionTagId","name","ownerId"],"properties":{"versionTagId":{"type":"string"},"name":{"type":"string"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"description":{"type":"string"},"color":{"type":"string","enum":["cyan","grass","violet","plum","amber","bronze"]}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tags"]}},"/v2/tags/{tagId}":{"delete":{"summary":"Delete a tag","description":"Delete a specific version tag. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.","parameters":[{"name":"tagId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteVersionTag","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tags"]},"patch":{"summary":"Update a tag","description":"Update the name, description, or color of a specific version tag.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.","parameters":[{"name":"tagId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateVersionTag","requestBody":{"description":"Update version tag request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the tag. Must be unique and a maximum of 32 characters."},"description":{"type":"string","description":"Description of the version tag."},"color":{"type":"string","enum":["cyan","grass","violet","plum","amber","bronze"],"description":"Color to associate with the tag."}},"description":"Update version tag request"}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["versionTagId","name","ownerId"],"properties":{"versionTagId":{"type":"string"},"name":{"type":"string"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"description":{"type":"string"},"color":{"type":"string","enum":["cyan","grass","violet","plum","amber","bronze"]}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tags"]}},"/v2/tags/{tagId}/workbooks":{"get":{"summary":"List workbooks for a tag","description":"Get a list of workbooks for a specific version tag. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.","parameters":[{"name":"tagId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listWorkbooksForTag","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["workbookId","workbookUrlId","name","url","path","latestVersion","ownerId"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"workbookUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number","description":"The most recently published document version of the workbook."},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","name","sourceWorkbookVersion","taggedWorkbookId","workbookTaggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"name":{"type":"string"},"sourceWorkbookVersion":{"type":"number"},"taggedWorkbookId":{"type":"string","description":"Unique identifier of the tagged workbook.","title":"Workbook ID"},"workbookTaggedAt":{"type":"string","format":"date-time"}}}},"description":{"type":"string"},"taggedSourceUrlId":{"type":"string","description":"For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request."}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"https://help.sigmacomputing.com/reference/createversiontag","description":"Sigma API documentation:"},"tags":["tags"]}},"/v2/teams":{"get":{"summary":"List teams","description":"\n  **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request.\n\n  List all teams in Sigma.\n  ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"name","schema":{"type":"string"},"in":"query"},{"name":"description","schema":{"type":"string"},"in":"query"},{"name":"visibility","schema":{"type":"string","enum":["public","private"]},"in":"query"}],"operationId":"listTeams","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"allOf":[{"type":"object","required":["teamId","createdBy","updatedBy","createdAt","updatedAt","name","description","visibility"],"properties":{"teamId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":["string","null"]},"visibility":{"type":["string","null"],"enum":["public","private"]}}},{"type":"object","properties":{"isArchived":{"type":"boolean"}}}]},"description":"One page of results","title":"Single page"},{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["teamId","createdBy","updatedBy","createdAt","updatedAt","name","description","visibility"],"properties":{"teamId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":["string","null"]},"visibility":{"type":["string","null"],"enum":["public","private"]}}},{"type":"object","properties":{"isArchived":{"type":"boolean"}}}]}},"nextPage":{"type":["string","null"]}},"description":"Multiple pages of results","title":"Paginated results"}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]},"post":{"summary":"Create a team","description":"Create a Sigma team.\n\n  ### Usage notes\n  - Specify members to add to the team by userId or memberId.\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n    ","parameters":[],"operationId":"createTeam","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"type":"object","properties":{"description":{"type":"string"},"members":{"type":"array","items":{"type":"string"},"description":"Specify memberIds"},"createTeamFolder":{"type":"boolean"},"visibility":{"type":"string","enum":["public","private"],"description":"Whether to make a public or private team. Defaults to private."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["teamId","createdBy","updatedBy","createdAt","updatedAt","name","description","visibility"],"properties":{"teamId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":["string","null"]},"visibility":{"type":["string","null"],"enum":["public","private"]}}},{"type":"object","properties":{"isArchived":{"type":"boolean"}}}]},{"type":"object","required":["members"],"properties":{"members":{"type":"array","items":{"type":"string"}}}}]},{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":["string","null"]}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]}},"/v2/teams/{teamId}":{"get":{"summary":"Get a team","description":"Returns details about a team based on team ID. The response includes an array of member IDs that identify the users in the team.\n\n  ### Usage notes\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  ","parameters":[{"name":"teamId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getTeam","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","required":["teamId","createdBy","updatedBy","createdAt","updatedAt","name","description","visibility"],"properties":{"teamId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":["string","null"]},"visibility":{"type":["string","null"],"enum":["public","private"]}}},{"type":"object","properties":{"isArchived":{"type":"boolean"}}}]},{"type":"object","required":["members"],"properties":{"members":{"type":"array","items":{"type":"string"}}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]},"patch":{"summary":"Update a team","description":"Update the name, description, and visibility of a team.\n\n  ### Usage notes\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  ","parameters":[{"name":"teamId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateTeam","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"visibility":{"type":"string","enum":["public","private"]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["teamId","createdBy","updatedBy","createdAt","updatedAt","name","description","visibility"],"properties":{"teamId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":["string","null"]},"visibility":{"type":["string","null"],"enum":["public","private"]}}},{"type":"object","properties":{"isArchived":{"type":"boolean"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]},"delete":{"summary":"Delete a team","description":"Delete a specific team.\n\n  ### Usage notes\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  ","parameters":[{"name":"teamId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteTeam","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]}},"/v2/teams/{teamId}/assignedUserAttributes":{"post":{"summary":"Assign user attributes to a team","description":"Assign one or more user attributes to a specific team.\n\n  ### Usage notes\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  - Retrieve a list of available user attributes by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Maximum 100 assignments per request.\n  ","parameters":[{"name":"teamId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"assignUserAttributesToTeam","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","items":{"type":"object","required":["userAttributeId","value"],"properties":{"userAttributeId":{"type":"string","description":"Unique identifier of the user attribute."},"value":{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"The value of the user attribute","title":"Attribute value"}}}}}},"examples":{"Request Example":{"value":{"assignments":[{"userAttributeId":"00000000-0000-0000-0000-000000000000","value":{"val":"South","type":"string"}},{"userAttributeId":"00000000-0000-0000-0000-000000000001","value":{"val":"Sales","type":"string"}}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]}},"/v2/teams/{teamId}/members":{"get":{"summary":"List team members","description":"Get a paginated list of team members in a specific team.\n\n  ### Usage notes\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  - Returns the members of the team by `userId`.\n\n  ### Usage scenarios\n  - Identify the admin of a team.\n  ","parameters":[{"name":"teamId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getTeamMembers","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["userId","isTeamAdmin","addedBy"],"properties":{"userId":{"type":"string","description":"User ID, equivalent to Member ID"},"isTeamAdmin":{"type":"boolean"},"addedBy":{"type":"string","description":"User ID of the user who added this member to the team"}}},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]},"patch":{"summary":"Update team members","description":"Update the members of a specific team.\n\n  ### Usage notes\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  - Inactive members cannot be added or removed from a team.\n  ","parameters":[{"name":"teamId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateTeamMembers","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"add":{"type":"array","items":{"type":"string"},"description":"Members to add by memberId"},"remove":{"type":"array","items":{"type":"string"},"description":"Members to remove by memberId"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]}},"/v2/teams/{teamId}/teamAdmins":{"patch":{"summary":"Update team admins","description":"Manage team admin status for existing members of a specific team.\n\n  ### Usage notes\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  ","parameters":[{"name":"teamId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateTeamAdmins","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"add":{"type":"array","items":{"type":"string"},"description":"Users to grant team admin status by memberId"},"remove":{"type":"array","items":{"type":"string"},"description":"Users to revoke team admin status from by memberId"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]}},"/v2/teams/{teamId}/user-attributes":{"get":{"summary":"Get team user attributes","description":"Get a list of user attributes assigned to a team.\n\n  ### Usage notes\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  ","parameters":[{"name":"teamId","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getTeamUserAttributeAssignments","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["userAttributeId","userAttributeName","value"],"properties":{"userAttributeId":{"type":"string","description":"ID of the user attribute."},"userAttributeName":{"type":"string","description":"Name of the user attribute."},"value":{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Value for the user attribute assigned to the team."}}}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]}},"/v2/templates":{"get":{"summary":"List templates","description":"Returns a list of available templates.\n\n  ### Usage notes\n  - Official Sigma templates are created by SigmaSchedulerRobot.\n  ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"source","schema":{"type":"string","enum":["internal","external"],"description":"Filters results to templates based on their source. Set to internal to only retrieve templates created within your organization. Set to external to only retrieve templates shared to your organization. Do not specify a source to list all templates regardless of their source.","title":"Template source"},"in":"query"},{"name":"search","schema":{"type":"string","description":"Filter results based on the name of the templates.","title":"Search by name"},"in":"query"}],"operationId":"listTemplates","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["templateId","templateUrlId","name","url","path","latestVersion"],"properties":{"templateId":{"type":"string"},"templateUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","name"],"properties":{"versionTagId":{"type":"string"},"name":{"type":"string"}}}}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["templates"]}},"/v2/templates/{templateId}":{"get":{"summary":"Get template","description":"Get a template by template ID.\n\n  ### Usage notes\n  - Retrieve the **templateId** by calling the [/v2/templates](https://help.sigmacomputing.com/reference/list-templates) endpoint.\n  ","parameters":[{"name":"templateId","schema":{"type":"string","description":"Template ID"},"in":"path","required":true}],"operationId":"getTemplate","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["templateId","templateUrlId","name","url","path","latestVersion"],"properties":{"templateId":{"type":"string"},"templateUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","name"],"properties":{"versionTagId":{"type":"string"},"name":{"type":"string"}}}}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["templates"]}},"/v2/templates/{templateId}/swapSources":{"post":{"summary":"Swap template data sources","description":"Swap the data sources used by a workbook template. You can swap from one connection to another, and/or from one dataset to another.\n\n  ### Usage notes\n  - Retrieve the **templateId** by calling the [/v2/templates](https://help.sigmacomputing.com/reference/list-templates) endpoint.\n  - Retrieve the **connectionId** to use as the **toId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - To map the sources of a specific element, you can use the table or dataset ID:\n\n    - Retrieve the **fromId** for a specific data element by calling the [/v2/workbooks/{workbookId}/lineage/elements/{elementId}](https://help.sigmacomputing.com/reference/list-lineage) endpoint and using the `source` key from the response, which looks like `inode-2PBoXx3UabchxF1F3l07kE`. The ID is everything after `inode-`.\n    - Retrieve table and dataset IDs by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint. Use the `typeFilters` option to filter for table and dataset files. Use `id` field in the response as the `fromId` or `toId`, as relevant.\n    ","parameters":[{"name":"templateId","schema":{"type":"string","description":"Template ID"},"in":"path","required":true}],"operationId":"sourceSwapTemplate","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"sourceMapping":{"type":"array","items":{"allOf":[{"type":"object","required":["fromId","toId"],"properties":{"fromId":{"type":"string","description":"ID of the dataset (deprecated) or table to swap from.","title":"Data source ID"},"toId":{"type":"string","description":"ID of the dataset (deprecated) or table to swap to.","title":"Data source ID"}}},{"type":"object","properties":{"metricMapping":{"type":"array","items":{"type":"object","required":["fromMetric","toMetric"],"properties":{"fromMetric":{"type":"string","description":"Metric in the data source.","title":"Metric name"},"toMetric":{"type":"string","description":"Metric in the data source.","title":"Metric name"}}}},"columnMapping":{"type":"array","items":{"type":"object","required":["fromColumn","toColumn"],"properties":{"fromColumn":{"oneOf":[{"type":"string","description":"Column in the data source.","title":"Column name"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link of the form [\"link_name\", \"column_name\"]","title":"Link"}]},"toColumn":{"oneOf":[{"type":"string","description":"Column in the data source.","title":"Column name"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link of the form [\"link_name\", \"column_name\"]","title":"Link"}]}}}}}}]}},"connectionMapping":{"type":"array","items":{"allOf":[{"type":"object","required":["fromId","toId"],"properties":{"fromId":{"type":"string","description":"ID of the connection to swap from.","title":"Connection ID"},"toId":{"type":"string","description":"ID of the connection to swap to.","title":"Connection ID"}}},{"type":"object","properties":{"swapTables":{"type":"boolean","description":"Whether to swap all tables in the connection","title":"Swap Tables"},"paths":{"type":"array","items":{"type":"object","required":["fromPath","toPath"],"properties":{"fromPath":{"type":"array","items":{"type":"string"},"description":"Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE']","title":"From Path"},"toPath":{"type":"array","items":{"type":"string"},"description":"Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE']","title":"To Path"}}}}}}]}},"copyInputTableData":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["unswappedSources","unswappedConnections"],"properties":{"unswappedSources":{"type":"array","items":{"type":"string"},"description":"IDs of sources in the workbook that were not swapped."},"unswappedConnections":{"type":"array","items":{"type":"string"},"description":"IDs of custom SQL connections in the workbook that were not swapped."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["templates"]}},"/v2/templates/save_workbook":{"post":{"summary":"Create workbook from template","description":"Create a workbook by saving it from a template.\n\n  ### Usage notes\n  - Retrieve the **templateId** by calling the [/v2/templates](https://help.sigmacomputing.com/reference/list-templates) endpoint.\n  - Retrieve the **folderId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. To use the \"My Documents\" folder as the destination folder, call the [/v2/members/{memberId}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response.\n  - If you leave the name or description options blank, the workbook created inherits the values of the template.\n  ","parameters":[],"operationId":"saveWorkbookFromTemplate","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["templateId","folderId"],"properties":{"templateId":{"type":"string"},"folderId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"updateAutomatically":{"type":"boolean"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["workbookId"],"properties":{"workbookId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["templates"]}},"/v2/tenants":{"post":{"summary":"Create a tenant organization","description":"Create a new tenant organization with the specified name and organization slug to be used in the URL.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- The **tenantOrganizationName** is displayed as the organization name in the Sigma interface.\n- The **tenantOrganizationSlug** must be unique and is used in URLs to identify the tenant organization.","parameters":[],"operationId":"createTenant","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["tenantOrganizationName","tenantOrganizationSlug"],"properties":{"tenantOrganizationName":{"type":"string","description":"Name of the tenant organization to create"},"tenantOrganizationSlug":{"type":"string","description":"URL identifier for the tenant organization"}}},{"type":"object","properties":{"cloudProvider":{"type":"string","enum":["aws","aws-au","aws-ca","aws-eu","aws-uk","aws-us-a","azure-au","azure-ca","azure-eu","azure-uk","azure-us","gcp","gcp-us"],"description":"Cloud provider to create the tenant organization in. Defaults to the same cloud provider as the parent organization"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["tenantOrganizationId","parentOrganizationId","createdBy","updatedBy","createdAt","updatedAt","tenantOrganizationName","tenantOrganizationSlug"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of the tenant organization"},"parentOrganizationId":{"type":"string","description":"Unique identifier of the tenant's parent organization"},"createdBy":{"type":"string","description":"Unique identifier of the user who created the tenant organization","title":"Unique identifier of the user who created the tenant organization"},"updatedBy":{"type":"string","description":"Unique identifier of the user who last updated the tenant organization","title":"Unique identifier of the user who last updated the tenant organization"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was created. Format: ISO 8601 timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was last updated. Format: ISO 8601 timestamp"},"tenantOrganizationName":{"type":"string","description":"Name of the tenant organization to create"},"tenantOrganizationSlug":{"type":"string","description":"URL identifier for the tenant organization"}}},{"type":"object","properties":{"sharedAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was shared, if applicable. Format: ISO 8601 timestamp"},"tenantCloudProvider":{"type":"string","description":"Cloud provider the tenant organization is hosted on"},"tenantRegion":{"type":"string","description":"Region the tenant organization is hosted in"},"tenantApiUrl":{"type":"string","description":"Base URL for accessing the tenant organization API"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tenants"]},"get":{"summary":"List tenant organizations","description":"Retrieve a paginated list of tenant organizations with optional filtering and sorting.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Use **pageToken** and **pageSize** parameters to manage paginated responses.\n- Use **search** to filter results by organization slug or ID of the user who created the tenant.\n- Use **key** and **order** to sort results by creation date, ID of the user who created the tenant, name, or URL.","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"},{"name":"key","schema":{"type":"string","enum":["createdAt","createdBy","name","url"],"description":"Field to sort the results by"},"in":"query"},{"name":"order","schema":{"type":"string","enum":["asc","desc"],"description":"Sort order for the results"},"in":"query"},{"name":"search","schema":{"type":"string","description":"Search term to filter tenant organizations by slug or creator"},"in":"query"}],"operationId":"listTenants","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["tenantOrganizationId","parentOrganizationId","createdBy","updatedBy","createdAt","updatedAt","tenantOrganizationName","tenantOrganizationSlug"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of the tenant organization"},"parentOrganizationId":{"type":"string","description":"Unique identifier of the tenant's parent organization"},"createdBy":{"type":"string","description":"Unique identifier of the user who created the tenant organization","title":"Unique identifier of the user who created the tenant organization"},"updatedBy":{"type":"string","description":"Unique identifier of the user who last updated the tenant organization","title":"Unique identifier of the user who last updated the tenant organization"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was created. Format: ISO 8601 timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was last updated. Format: ISO 8601 timestamp"},"tenantOrganizationName":{"type":"string","description":"Name of the tenant organization to create"},"tenantOrganizationSlug":{"type":"string","description":"URL identifier for the tenant organization"}}},{"type":"object","properties":{"sharedAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was shared, if applicable. Format: ISO 8601 timestamp"},"tenantCloudProvider":{"type":"string","description":"Cloud provider the tenant organization is hosted on"},"tenantRegion":{"type":"string","description":"Region the tenant organization is hosted in"},"tenantApiUrl":{"type":"string","description":"Base URL for accessing the tenant organization API"}}}]},{"type":"null"}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tenants"]}},"/v2/tenants/{tenantOrganizationId}":{"patch":{"summary":"Update details of a tenant organization","description":"Update the details of an existing tenant organization. The organization name and slug can be updated through this endpoint.\n    \n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint.","parameters":[{"name":"tenantOrganizationId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"patchTenant","requestBody":{"description":"Request parameters for updating a tenant organization","content":{"application/json":{"schema":{"type":"object","properties":{"tenantOrganizationName":{"type":"string","description":"New name for the tenant organization"},"tenantOrganizationSlug":{"type":"string","description":"New URL identifier for the tenant organization"}},"description":"Request parameters for updating a tenant organization"}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["tenantOrganizationId","parentOrganizationId","createdBy","updatedBy","createdAt","updatedAt","tenantOrganizationName","tenantOrganizationSlug"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of the tenant organization"},"parentOrganizationId":{"type":"string","description":"Unique identifier of the tenant's parent organization"},"createdBy":{"type":"string","description":"Unique identifier of the user who created the tenant organization","title":"Unique identifier of the user who created the tenant organization"},"updatedBy":{"type":"string","description":"Unique identifier of the user who last updated the tenant organization","title":"Unique identifier of the user who last updated the tenant organization"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was created. Format: ISO 8601 timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was last updated. Format: ISO 8601 timestamp"},"tenantOrganizationName":{"type":"string","description":"Name of the tenant organization to create"},"tenantOrganizationSlug":{"type":"string","description":"URL identifier for the tenant organization"}}},{"type":"object","properties":{"sharedAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was shared, if applicable. Format: ISO 8601 timestamp"},"tenantCloudProvider":{"type":"string","description":"Cloud provider the tenant organization is hosted on"},"tenantRegion":{"type":"string","description":"Region the tenant organization is hosted in"},"tenantApiUrl":{"type":"string","description":"Base URL for accessing the tenant organization API"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tenants"]},"delete":{"summary":"Delete a tenant organization","description":"Delete a tenant organization by tenantOrganizationId.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint.\n- This action permanently removes the tenant organization and cannot be undone.","parameters":[{"name":"tenantOrganizationId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteTenant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tenants"]},"get":{"summary":"Get details for a tenant organization","description":"Retrieve details of a specific tenant organization by tenantOrganizationId.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint.","parameters":[{"name":"tenantOrganizationId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getTenant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["tenantOrganizationId","parentOrganizationId","createdBy","updatedBy","createdAt","updatedAt","tenantOrganizationName","tenantOrganizationSlug"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of the tenant organization"},"parentOrganizationId":{"type":"string","description":"Unique identifier of the tenant's parent organization"},"createdBy":{"type":"string","description":"Unique identifier of the user who created the tenant organization","title":"Unique identifier of the user who created the tenant organization"},"updatedBy":{"type":"string","description":"Unique identifier of the user who last updated the tenant organization","title":"Unique identifier of the user who last updated the tenant organization"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was created. Format: ISO 8601 timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was last updated. Format: ISO 8601 timestamp"},"tenantOrganizationName":{"type":"string","description":"Name of the tenant organization to create"},"tenantOrganizationSlug":{"type":"string","description":"URL identifier for the tenant organization"}}},{"type":"object","properties":{"sharedAt":{"type":"string","format":"date-time","description":"Timestamp when the tenant organization was shared, if applicable. Format: ISO 8601 timestamp"},"tenantCloudProvider":{"type":"string","description":"Cloud provider the tenant organization is hosted on"},"tenantRegion":{"type":"string","description":"Region the tenant organization is hosted in"},"tenantApiUrl":{"type":"string","description":"Base URL for accessing the tenant organization API"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tenants"]}},"/v2/tenants/{tenantOrganizationId}/capabilities/deployments":{"get":{"summary":"List tenant deployment capabilities","description":"Retrieve a paginated list of tenant organizations that the specified tenant organization can deploy to.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint.\n- Use **pageToken** and **pageSize** to paginate results.","parameters":[{"name":"tenantOrganizationId","schema":{"type":"string","description":"Unique identifier of the tenant organization whose deployment capabilities are being managed.","title":"Tenant Organization ID"},"in":"path","required":true},{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"listTenantDeploymentCapabilities","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["tenantOrganizationId"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of a tenant organization that can be deployed to."}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]},"examples":{"SDLC: Test tenant can deploy to Prod tenant":{"value":{"entries":[{"tenantOrganizationId":"b7f3a9e1-6c2d-4a8f-9b3e-2f7a5d1c8e4b"}]}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tenants"]}},"/v2/tenants/{tenantOrganizationId}/capabilities/deployments:batchAdd":{"post":{"summary":"Add deployment capabilities to a tenant","description":"Grant a tenant organization the capability to deploy to other tenant organizations.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve **tenantOrganizationId** values by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint.","parameters":[{"name":"tenantOrganizationId","schema":{"type":"string","description":"Unique identifier of the tenant organization whose deployment capabilities are being managed.","title":"Tenant Organization ID"},"in":"path","required":true}],"operationId":"addTenantDeploymentCapabilities","requestBody":{"description":"Request parameters for adding tenant deployment capabilities","content":{"application/json":{"schema":{"type":"object","required":["deployToTenantOrganizationIds"],"properties":{"deployToTenantOrganizationIds":{"type":"array","items":{"type":"string"},"description":"The tenant organizations that this tenant can deploy to."}},"description":"Request parameters for adding tenant deployment capabilities"},"examples":{"SDLC: Test tenant can deploy to Prod tenant":{"value":{"deployToTenantOrganizationIds":["b7f3a9e1-6c2d-4a8f-9b3e-2f7a5d1c8e4b"]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["capabilities"],"properties":{"capabilities":{"type":"array","items":{"type":"object","required":["tenantOrganizationId"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of a tenant organization that can be deployed to."}}}}}},"examples":{"SDLC: Test tenant can deploy to Prod tenant":{"value":{"capabilities":[{"tenantOrganizationId":"b7f3a9e1-6c2d-4a8f-9b3e-2f7a5d1c8e4b"}]}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tenants"]}},"/v2/tenants/{tenantOrganizationId}/capabilities/deployments:batchRemove":{"post":{"summary":"Remove deployment capabilities from a tenant","description":"Revoke a tenant organization's capability to deploy to one or more tenant organizations.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve **tenantOrganizationId** values by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint.\n- Existing deployments from this tenant organization to the specified tenant organizations will be removed.","parameters":[{"name":"tenantOrganizationId","schema":{"type":"string","description":"Unique identifier of the tenant organization whose deployment capabilities are being managed.","title":"Tenant Organization ID"},"in":"path","required":true}],"operationId":"removeTenantDeploymentCapabilities","requestBody":{"description":"Request parameters for removing tenant deployment capabilities","content":{"application/json":{"schema":{"type":"object","required":["deployToTenantOrganizationIds"],"properties":{"deployToTenantOrganizationIds":{"type":"array","items":{"type":"string"},"description":"The tenant organizations that this tenant can no longer deploy to"}},"description":"Request parameters for removing tenant deployment capabilities"},"examples":{"SDLC: Revoke Test tenant deploying to Prod tenant":{"value":{"deployToTenantOrganizationIds":["b7f3a9e1-6c2d-4a8f-9b3e-2f7a5d1c8e4b"]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tenants"]}},"/v2/tenants/{tenantOrganizationId}/workbooks":{"get":{"summary":"Get deployed workbook in tenant organization","description":"Retrieve the workbook ID for a workbook deployed to a tenant organization for a given parent workbook and deployment policy.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- The parent workbook must be part of the specified deployment policy.\n- The workbook must be deployed to the specified tenant organization.\n- Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint.\n- Retrieve the **deploymentPolicyId** by calling the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint. \n- Retrieve the **parentWorkbookId** by calling the [/v2/deploymentPolicies/{deploymentPolicyId}/files](https://help.sigmacomputing.com/reference/list-inodes-for-deployment) endpoint and using the `workbookId` included in the response.\n- For version-tagged deployment policies, you may pass either the source workbook ID or the version-tagged workbook ID as the **parentWorkbookId**.","parameters":[{"name":"tenantOrganizationId","schema":{"type":"string"},"in":"path","required":true},{"name":"parentWorkbookId","schema":{"type":"string","description":"Unique identifier of the workbook in the parent organization. For version-tagged deployments, this can be either the source workbook ID or the version-tagged workbook ID."},"in":"query"},{"name":"deploymentPolicyId","schema":{"type":"string","description":"The ID of the deployment policy that contains the workbook"},"in":"query"}],"operationId":"getTenantWorkbook","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["workbookId","workbookUrl"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook deployed to the tenant organization"},"workbookUrl":{"type":"string","description":"URL to access the workbook in the tenant organization"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["tenants"]}},"/v2/translations/organization":{"get":{"summary":"List organization translation files","description":"This paginated endpoint lists all the translation files that have been defined at the organization level.\n\n### Usage notes\nThis endpoint requires no parameters for basic requests but supports query parameters for pagination and response limit.\n\n#### Pagination\n\nThis endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:\n\n- hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.\n- total: The total number of entries available across all pages.\n- nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.\n\n#### Example response for pagination\n{\n  \"hasMore\": true,\n  \"total\": 104,\n  \"nextPage\": \"50\"\n}\n\nTo request additional pages, include the `nextPage` option in your followup request according to the endpoint's parameter requirements. This process can be repeated until `nextPage` is `null`.\n    ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listOrgLocales","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["lng","locale","lng_variant","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"lng":{"type":"string","description":"The locale identifier corresponding to the language of the translation.","title":"Locale identifier"},"locale":{"type":"string","description":"The corrected locale identifier corresponding to the language of the translation. This identifier can be used in Sigma's query parameters (ex. `:lng=en-gb`)","title":"Locale identifier"},"lng_variant":{"type":["string","null"],"description":"The name of the custom translation variant, if applicable","title":"Variant name"},"createdBy":{"type":"string","description":"The user ID of the creator"},"updatedBy":{"type":"string","description":"The user ID of the last updater"},"createdAt":{"type":"string","format":"date-time","description":"The creation timestamp"},"updatedAt":{"type":"string","format":"date-time","description":"The last update timestamp"}}},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["translations"]},"post":{"summary":"Create organization translation file","description":"This endpoint creates a new organization translation file for the specified locale, containing the translation key-value pairs, if provided. You can also use this endpoint to create custom translations for a locale.\nEntering common phrases and their translations used in workbooks across your organization ensures consistent translations for all users.\n\n### Usage Notes\n- Retrieve the supported locale identifiers to use for **lng** from [Supported languages and locales](/docs/manage-workbook-localization#supported-languages-and-locales).\n","parameters":[],"operationId":"createOrgTranslation","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["lng"],"properties":{"lng":{"type":"string","description":"The locale identifier corresponding to the language of the translation.","title":"Locale identifier"}}},{"type":"object","properties":{"lng_variant":{"type":["string","null"],"description":"The name of the custom translation variant, if applicable","title":"Variant name"},"translations":{"type":"object","additionalProperties":{"type":"string"},"description":"A JSON object with phrases as keys and their translations as values","title":"Translation file"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["translations"]}},"/v2/translations/organization/{lng}":{"get":{"summary":"Get organization translation file","description":"This endpoint returns a JSON file containing the translations for a specified locale (**lng**) without custom translations.\n\n### Usage notes\n- Retrieve the **lng** by calling the [/v2/translations/organization](https://help.sigmacomputing.com/reference/list-org-locales) endpoint.\n  ","parameters":[{"name":"lng","schema":{"type":"string","description":"The locale identifier corresponding to the language of the translation.","title":"Locale identifier"},"in":"path","required":true}],"operationId":"getOrgTranslations","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["translations"],"properties":{"translations":{"type":"object","additionalProperties":{"type":"string"},"description":"A JSON object with phrases as keys and their translations as values","title":"Translation file"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["translations"]},"put":{"summary":"Update organization translation file","description":"This endpoint updates the translation file for a specified locale (**lng**) without custom translations.\n\n### Usage notes\n- Retrieve the **lng** by calling the [/v2/translations/organization](https://help.sigmacomputing.com/reference/list-org-locales) endpoint.\n  ","parameters":[{"name":"lng","schema":{"type":"string","description":"The locale identifier corresponding to the language of the translation.","title":"Locale identifier"},"in":"path","required":true}],"operationId":"updateOrgTranslation","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["translations"],"properties":{"translations":{"type":"object","additionalProperties":{"type":"string"},"description":"A JSON object with phrases as keys and their translations as values","title":"Translation file"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["translations"]},"delete":{"summary":"Delete organization translation file","description":"This endpoint deletes the translation file for the specified locale (**lng**) without any custom translations.\n\n### Usage notes\n- Retrieve the **lng** by calling the [/v2/translations/organization](https://help.sigmacomputing.com/reference/list-org-locales) endpoint.\n  ","parameters":[{"name":"lng","schema":{"type":"string","description":"The locale identifier corresponding to the language of the translation.","title":"Locale identifier"},"in":"path","required":true}],"operationId":"deleteOrgTranslation","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["translations"]}},"/v2/translations/organization/{lng}/{lng_variant}":{"get":{"summary":"Get organization translation file with variant","description":"This endpoint returns a JSON file containing the translations and custom translations (**lng_variant**) for a locale (**lng**).\n\n### Usage notes\n- Retrieve the **lng** and **lng_variant** by calling the [/v2/translations/organization](https://help.sigmacomputing.com/reference/list-org-locales) endpoint.\n  ","parameters":[{"name":"lng","schema":{"type":"string","description":"The locale identifier corresponding to the language of the translation.","title":"Locale identifier"},"in":"path","required":true},{"name":"lng_variant","schema":{"type":"string","description":"The name of the custom translation variant","title":"Variant name"},"in":"path","required":true}],"operationId":"getOrgTranslationsWithVariant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["translations"],"properties":{"translations":{"type":"object","additionalProperties":{"type":"string"},"description":"A JSON object with phrases as keys and their translations as values","title":"Translation file"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["translations"]},"put":{"summary":"Update organization translation file with variant","description":"This endpoint updates the translation file for the specified custom translation (**lng_variant**) for a locale (**lng**).\n\n### Usage notes\n- Retrieve the **lng** and **lng_variant** by calling the [/v2/translations/organization](https://help.sigmacomputing.com/reference/list-org-locales) endpoint.\n  ","parameters":[{"name":"lng","schema":{"type":"string","description":"The locale identifier corresponding to the language of the translation.","title":"Locale identifier"},"in":"path","required":true},{"name":"lng_variant","schema":{"type":"string","description":"The name of the custom translation variant","title":"Variant name"},"in":"path","required":true}],"operationId":"updateOrgTranslationWithVariant","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["translations"],"properties":{"translations":{"type":"object","additionalProperties":{"type":"string"},"description":"A JSON object with phrases as keys and their translations as values","title":"Translation file"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["translations"]},"delete":{"summary":"Delete organization translation file with variant","description":"This endpoint deletes the translation file for the specified custom translation (**lng_variant**) for a locale (**lng**).\n\n### Usage notes\n- Retrieve the **lng** and **lng_variant** by calling the [/v2/translations/organization](https://help.sigmacomputing.com/reference/list-org-locales) endpoint.\n  ","parameters":[{"name":"lng","schema":{"type":"string","description":"The locale identifier corresponding to the language of the translation.","title":"Locale identifier"},"in":"path","required":true},{"name":"lng_variant","schema":{"type":"string","description":"The name of the custom translation variant","title":"Variant name"},"in":"path","required":true}],"operationId":"deleteOrgTranslationWithVariant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["translations"]}},"/v2/user-attributes":{"get":{"summary":"List user attributes","description":"Get a list of available user attributes, values, and owners.","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"name","schema":{"type":"string","description":"Search filter for the name of the user attribute."},"in":"query"}],"operationId":"listUserAttributes","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["userAttributeId","name"],"properties":{"userAttributeId":{"type":"string","description":"Unique identifier of the user attribute."},"name":{"type":"string","description":"Name of the user attribute."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":["string","null"],"description":"Description of the user attribute."},"defaultValue":{"type":["object","null"],"required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Default value of the user attribute."}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]},"post":{"summary":"Create a user attribute","description":"Create a new user attribute. An optional description and default value can be provided.","parameters":[],"operationId":"createUserAttribute","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the user attribute."}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the user attribute."},"defaultValue":{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Default value of the user attribute.","title":"Default value"}}}]},"examples":{"Request Example":{"value":{"name":"department","description":"The user’s home department.","defaultValue":{"type":"string","val":"engineering"}}},"Tenant deployment swap example":{"value":{"name":"tenant_snowflake_connection","description":"Connection ID of the Snowflake connection to swap to when deploying to a tenant."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["userAttributeId","name"],"properties":{"userAttributeId":{"type":"string","description":"Unique identifier of the user attribute."},"name":{"type":"string","description":"Name of the user attribute."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":["string","null"],"description":"Description of the user attribute."},"defaultValue":{"type":["object","null"],"required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Default value of the user attribute."}}}]},"examples":{"Tenant deployment swap example":{"value":{"userAttributeId":"e4b7c2a1-9d3f-4e6b-8a2c-5f1d9e3b7a4c","name":"tenant_snowflake_connection","description":"Connection ID of the Snowflake connection to swap to when deploying to a tenant.","createdBy":"qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h","updatedBy":"qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h","createdAt":"2026-08-20T16:45:00.000Z","updatedAt":"2026-08-20T16:45:00.000Z"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]}},"/v2/user-attributes/{userAttributeId}":{"delete":{"summary":"Delete a user attribute","description":"Delete a user attribute.\n\n### Usage notes\n- To perform this operation, you must use API credentials owned by a user assigned the Admin account type.\n- Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n- This action permanently removes the user attribute from the organization and cannot be undone.\n      ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true}],"operationId":"deleteUserAttribute","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]},"get":{"summary":"Get a user attribute","description":"Get details for a specific user attribute.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true}],"operationId":"getUserAttribute","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["userAttributeId","name"],"properties":{"userAttributeId":{"type":"string","description":"Unique identifier of the user attribute."},"name":{"type":"string","description":"Name of the user attribute."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":["string","null"],"description":"Description of the user attribute."},"defaultValue":{"type":["object","null"],"required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Default value of the user attribute."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]},"patch":{"summary":"Update a user attribute","description":"Update the name, description, or default value of a user attribute. Only the fields included in the request are changed.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Sigma-managed user attributes, such as /`home_page/` cannot be renamed.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true}],"operationId":"updateUserAttribute","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"userAttributeName":{"type":"string","description":"Name of the user attribute."},"description":{"type":"string","description":"Description of the user attribute."},"defaultValue":{"type":["object","null"],"required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Default value of the user attribute. Pass null to clear the current default value.","title":"Default value"}}},"examples":{"Request Example":{"value":{"description":"The user’s home department.","defaultValue":{"type":"string","val":"engineering"}}},"Clear default value":{"value":{"defaultValue":null}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["userAttributeId","name"],"properties":{"userAttributeId":{"type":"string","description":"Unique identifier of the user attribute."},"name":{"type":"string","description":"Name of the user attribute."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"description":{"type":["string","null"],"description":"Description of the user attribute."},"defaultValue":{"type":["object","null"],"required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Default value of the user attribute."}}}]},"examples":{"Response Example":{"value":{"userAttributeId":"e4b7c2a1-9d3f-4e6b-8a2c-5f1d9e3b7a4c","name":"department","description":"The user’s home department.","defaultValue":{"type":"string","val":"engineering"},"createdBy":"qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h","updatedBy":"qJ8VpXeRp3ZvNtLm6WkYbGjFcAoS9h","createdAt":"2026-08-20T16:45:00.000Z","updatedAt":"2026-08-20T17:12:00.000Z"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]}},"/v2/user-attributes/{userAttributeId}/teams":{"get":{"summary":"Get teams for a user attribute","description":"Get a list of teams that have a specific user attribute defined, and the assigned value for the user attribute.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getUserAttributeTeamAssignments","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["teamId","value","priority"],"properties":{"teamId":{"type":"string","description":"Unique identifier of the team."},"value":{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Assigned value."},"priority":{"type":"number","description":"Priority of the assignment."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]},"patch":{"summary":"Update a user attribute for teams","description":"Update a user attribute for one or more teams. Currently, this endpoint only supports deleting a user attribute assignment.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true}],"operationId":"updateUserAttributeForTeams","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["delete"],"properties":{"delete":{"type":"array","items":{"type":"object","required":["teamId"],"properties":{"teamId":{"type":"string","description":"Unique identifier of the team."}}},"description":"The teams whose assignments are to be revoked."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]},"post":{"summary":"Set a user attribute for teams","description":"Assign and set the value of a specific user attribute for one or more teams.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true}],"operationId":"setUserAttributeForTeams","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","items":{"type":"object","required":["teamId","value"],"properties":{"teamId":{"type":"string","description":"Unique identifier of the team."},"value":{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"The value of the user attribute","title":"Attribute value"}}}}}},"examples":{"Request Example":{"value":{"assignments":[{"teamId":"00000000-0000-0000-0000-000000000000","value":{"type":"string","val":"foo"}},{"teamId":"00000000-0000-0000-0000-000000000001","value":{"type":"string","val":"bar"}}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]}},"/v2/user-attributes/{userAttributeId}/teams/{teamId}":{"delete":{"summary":"Delete a user attribute for a team","description":"Delete a specific user attribute for a specific team.\n\n### Usage notes\n- Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n- Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n      ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true},{"name":"teamId","schema":{"type":"string","description":"Unique identifier of the team."},"in":"path","required":true}],"operationId":"deleteUserAttributeForTeam","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]}},"/v2/user-attributes/{userAttributeId}/tenants":{"get":{"summary":"Get tenants for a user attribute","description":"Get a list of tenants that have a specific user attribute defined, and the assigned value for the user attribute.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getUserAttributeTenantAssignments","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["tenantOrganizationId","value"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of the tenant."},"value":{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Assigned value."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]},"patch":{"summary":"Update a user attribute for tenants","description":"Update a user attribute for one or more tenants. Currently, this endpoint only supports deleting a user attribute assignment.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Specify one or more tenants by tenantOrganizationId. Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint and using the `tenantOrganizationId` included in the response.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true}],"operationId":"updateUserAttributeForTenants","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["delete"],"properties":{"delete":{"type":"array","items":{"type":"object","required":["tenantOrganizationId"],"properties":{"tenantOrganizationId":{"type":"string","description":"The unique identifier of the tenant."}}},"description":"The tenants whose assignments are to be revoked."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]},"post":{"summary":"Set a user attribute for tenants","description":"Assign and set the value of a specific user attribute for one or more tenants.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Specify one or more tenant by tenantOrganizationId. Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint and using the `tenantOrganizationId` included in the response.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true}],"operationId":"setUserAttributeForTenants","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","items":{"type":"object","required":["tenantOrganizationId","value"],"properties":{"tenantOrganizationId":{"type":"string","description":"Unique identifier of the tenant."},"value":{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"The value of the user attribute","title":"Attribute value"}}}}}},"examples":{"Request Example":{"value":{"assignments":[{"tenantOrganizationId":"00000000-0000-0000-0000-000000000000","value":{"type":"string","val":"foo"}},{"tenantOrganizationId":"00000000-0000-0000-0000-000000000001","value":{"type":"string","val":"bar"}}]}},"Tenant connection swap":{"value":{"assignments":[{"tenantOrganizationId":"5e9c2b7a-3f1d-4a8e-9b6c-2d4f8a1e6c3b","value":{"type":"string","val":"3d4e8f21-7b6c-4a9d-8e12-5f6a7b8c9d0e"}},{"tenantOrganizationId":"1f4a8c3e-6d2b-4e9a-8c1f-5b7d3a2e9f6c","value":{"type":"string","val":"7c1b9e4a-2f5d-4b8e-9a3c-1e2f3a4b5c6d"}}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]}},"/v2/user-attributes/{userAttributeId}/tenants/{tenantOrganizationId}":{"delete":{"summary":"Delete a user attribute for a tenant","description":"Delete a specific user attribute for a specific tenant.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint and using the `tenantOrganizationId` included in the response.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true},{"name":"tenantOrganizationId","schema":{"type":"string","description":"Unique identifier of the tenant."},"in":"path","required":true}],"operationId":"deleteUserAttributeForTenant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]}},"/v2/user-attributes/{userAttributeId}/users":{"get":{"summary":"Get users for a user attribute","description":"Get a list of users that have a specific user attribute defined, and the assigned value for the user attribute.\n\n### Usage notes\n- Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n- Retrieve the **userId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint and using the `memberId` included in the response.\n- Use **userId** to return a single user's assignment. The response is empty if the attribute is not assigned to that user.\n- Only values assigned **directly to a user** are returned. Default values and values a user inherits from a team are not included.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"userId","schema":{"type":"string","description":"Unique identifier of the user.","title":"User ID"},"in":"query"}],"operationId":"getUserAttributeUserAssignments","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["userId","value"],"properties":{"userId":{"type":"string","description":"Unique identifier of the user."},"value":{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"Assigned value."}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]},"patch":{"summary":"Update a user attribute for users","description":"Update a user attribute for one or more users. Currently, this endpoint only supports deleting a user attribute assignment.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Specify one or more users by userId. Retrieve the **userId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint and using the `memberId` included in the response.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true}],"operationId":"updateUserAttributeForUsers","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["delete"],"properties":{"delete":{"type":"array","items":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The unique identifier of the user."}}},"description":"The users whose assignments are to be revoked."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]},"post":{"summary":"Set a user attribute for users","description":"Assign and set the value of a specific user attribute for one or more users.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Specify one or more users by userId. Retrieve the **userId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint and using the `memberId` included in the response.\n    ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true}],"operationId":"setUserAttributeForUsers","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","items":{"type":"object","required":["userId","value"],"properties":{"userId":{"type":"string","description":"Unique identifier of the user."},"value":{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"],"description":"Type of user attribute."},"val":{"type":"string","description":"Value of the user attribute."}},"description":"The value of the user attribute","title":"Attribute value"}}}}}},"examples":{"Request Example":{"value":{"assignments":[{"userId":"mTwJbaYKQbBexvF4ZWGeRxuAmbGKm","value":{"type":"string","val":"foo"}},{"userId":"mTwJbaYKQbBexvF4ZWGeRxuAmbGKn","value":{"type":"string","val":"bar"}}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]}},"/v2/user-attributes/{userAttributeId}/users/{userId}":{"delete":{"summary":"Delete a user attribute for a user","description":"Delete a specific user attribute for a specific user.\n\n  ### Usage notes\n  - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.\n  - Retrieve the **userId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint and using the `memberId` included in the response.\n      ","parameters":[{"name":"userAttributeId","schema":{"type":"string","description":"Unique identifier of the user attribute."},"in":"path","required":true},{"name":"userId","schema":{"type":"string","description":"Unique identifier of the user."},"in":"path","required":true}],"operationId":"deleteUserAttributeForUser","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["user-attributes"]}},"/v2/webhooks/{workbookId}/{sequenceId}":{"post":{"summary":"Send to a webhook (Beta)","description":"Post data to a webhook endpoint. The request body must match the webhook specification configured in Sigma.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\nTo retrieve the expected request body fields before sending data, see the [/v2/webhooks/{workbookId}/{sequenceId}/schema](getwebhookschema) endpoint.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint.\n- Retrieve the webhook URL, which contains the **workbookId** and **sequenceId**, by creating a webhook through the Sigma UI. The URL will be formatted as `/v2/webhooks/{workbookId}/{sequenceId}`.\n    ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"The unique identifier of the workbook."},"in":"path","required":true},{"name":"sequenceId","schema":{"type":"string","description":"The unique identifier of the sequence."},"in":"path","required":true}],"operationId":"webhooks","requestBody":{"description":"A JSON object that matches the webhook specification configured in Sigma.","content":{"application/json":{"schema":{"type":"object","description":"A JSON object that matches the webhook specification configured in Sigma."}}}},"responses":{"202":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"The action trace ID."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["webhooks"]}},"/v2/webhooks/{workbookId}/{sequenceId}/schema":{"get":{"summary":"Retrieve webhook message schema (Beta)","description":"Retrieve the schema for an action sequence in a workbook configured to be triggered from a webhook.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\nTo send data to this webhook, see the [/v2/webhooks/{workbookId}/{sequenceId}](webhooks) endpoint.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](listworkbooks) endpoint.\n- Retrieve the webhook URL, which contains the **workbookId** and **sequenceId**, by creating a webhook through the Sigma UI. The URL will be formatted as `/v2/webhooks/{workbookId}/{sequenceId}`.\n- The keys included in the response `variables` are the same JSON keys used in the POST body for [/v2/webhooks/{workbookId}/{sequenceId}](webhooks).\n    ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"The unique identifier of the workbook."},"in":"path","required":true},{"name":"sequenceId","schema":{"type":"string","description":"The unique identifier of the sequence."},"in":"path","required":true}],"operationId":"getWebhookSchema","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["variables"],"properties":{"variables":{"type":"object","additionalProperties":{"type":"object"},"description":"Key-value pairs of the fields to send to a webhook."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["webhooks"]}},"/v2/whoami":{"get":{"summary":"Get current user","description":"Get the identity and authentication status of the current user.\n\n  ### Usage notes\n  Call this endpoint after authenticating to retrieve user details. It does not require any parameters other than the user's valid session or authentication token included in the request headers.\n\n  ### Usage scenarios\n  - **Session validation:** Quickly confirm user authentication and retrieve session-specific details at the start of a new session.\n  - **User configuration:** Retrieve settings or configurations specific to the user, allowing for a customized application experience based on user roles and permissions.\n\n  ### Best practices\n  - Call this endpoint at the beginning of each session to ensure that the user's credentials are still valid and have not been revoked.\n  - Use the information provided by this endpoint to tailor the user interface and functionality accessible to the user, enhancing security and user experience.","parameters":[],"operationId":"whoAmI","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["userId","organizationId"],"properties":{"userId":{"type":"string"},"organizationId":{"type":"string"}},"title":"Current user information"}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["whoami"]}},"/v2/workbookAgents":{"get":{"summary":"List agents (Beta)","description":"List the Sigma agents that you can access across every workbook in the organization. Any agent in a workbook that you are granted **Can view** access to is returned in the response.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 100. Defaults to 20.","title":"Page size"},"in":"query"}],"operationId":"listWorkbookAgents","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["agentId","workbookId","agentName"],"properties":{"agentId":{"type":"string","description":"Unique identifier of the agent within a workbook.","title":"Agent ID"},"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"agentName":{"type":["string","null"],"description":"Display name of the agent."}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbookAgents"]}},"/v2/workbooks":{"get":{"summary":"List workbooks","description":"This endpoint retrieves a list of all available workbooks.\n\n  Available workbooks include any workbooks in your My Documents folder and any workbooks you have access to.\n\n  Users with the Admin account type can optionally retrieve all workbooks in the organization.\n\n  ### Usage notes\n  This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.\n\n  #### Pagination\n\n  This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:\n\n  - hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.\n  - total: The total number of entries available across all pages.\n  - nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.\n\n  #### Example response for pagination\n ```json\n  {\n    \"hasMore\": true,\n    \"total\": 104,\n    \"nextPage\": \"50\"\n  }\n  ```\n\n  To request additional pages, include the `nextPage` option in your next request as the value of the `page` option. Repeat this process until `nextPage` returns `null`, indicating that there are no more pages to return.\n\n  ### Usage scenarios\n  - **Workbook navigation:** Allows users to easily navigate through their collection of workbooks and access the one they need.\n  - **Integration points:** Useful for building integrations that need to present users with a list of their available workbooks, such as in custom applications using Sigma Embeds.","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"excludeTags","schema":{"type":"boolean"},"in":"query"},{"name":"skipPermissionCheck","schema":{"type":"boolean","description":"Only available to Sigma admins. Return all workbooks, including explorations, regardless of whether the user has access."},"in":"query"},{"name":"isArchived","schema":{"type":"boolean","description":"Return archived workbooks."},"in":"query"},{"name":"excludeExplorations","schema":{"type":"boolean","description":"When used with `skipPermissionCheck`, excludes explorations from the results, otherwise ignored."},"in":"query"}],"operationId":"listWorkbooks","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["workbookId","workbookUrlId","name","url","path","latestVersion","ownerId"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"workbookUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number","description":"The most recently published document version of the workbook."},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","name","sourceWorkbookVersion","taggedWorkbookId","workbookTaggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"name":{"type":"string"},"sourceWorkbookVersion":{"type":"number"},"taggedWorkbookId":{"type":"string","description":"Unique identifier of the tagged workbook.","title":"Workbook ID"},"workbookTaggedAt":{"type":"string","format":"date-time"}}}},"description":{"type":"string"},"taggedSourceUrlId":{"type":"string","description":"For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request."}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"post":{"summary":"Create a workbook","description":"This endpoint lets you create an empty workbook in Sigma, letting you start a data analysis project or report without any pre-existing templates or data sources set up.\n\n### Usage notes\n- The `name` parameter is required to provide a name for the new workbook.\n- Use the **folderId** to specify the folder in which to save the workbook. Retrieve the **folderId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n\n### Usage scenarios\n- **Project initialization**: When starting a new project that requires data analysis or reporting, users can quickly generate a new blank workbook to begin structuring their data and analyses.\n- **Template preparation**: Administrators or team leads might create blank workbooks to set up standardized templates that their teams can use to maintain consistency in data handling and reporting.\n\n### Best practices\n- **Naming conventions**: Establish and follow consistent naming conventions for workbooks to make it easier to manage and identify them within larger projects.\n- **Folder organization**: Use the **folderId** to organize workbooks into relevant folders, which helps in maintaining a tidy workspace, especially in environments with multiple users or teams.\n- **Access control**: Regularly review and manage access permissions for new workbooks, ensuring that only the appropriate personnel can view or edit sensitive data.","parameters":[],"operationId":"createWorkbook","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["folderId","name"],"properties":{"folderId":{"type":"string","description":"ID of the folder where the new workbook is created.","title":"Folder ID"},"name":{"type":"string","description":"Name of the new workbook.","title":"Workbook Name"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the workbook.","title":"Description"},"ownerId":{"type":"string","description":"ID of the user (member) to own the workbook.","title":"Owner ID"}}}]},"examples":{"Create a blank workbook":{"value":{"folderId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff","name":"My new blank Workbook","description":"This is a description","ownerId":"FFFFFFFFFFFFFFF99999999999999"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["workbookId","workbookUrlId","name","url","path","latestVersion","ownerId"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"workbookUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number","description":"The most recently published document version of the workbook."},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","name","sourceWorkbookVersion","taggedWorkbookId","workbookTaggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"name":{"type":"string"},"sourceWorkbookVersion":{"type":"number"},"taggedWorkbookId":{"type":"string","description":"Unique identifier of the tagged workbook.","title":"Workbook ID"},"workbookTaggedAt":{"type":"string","format":"date-time"}}}},"description":{"type":"string"},"taggedSourceUrlId":{"type":"string","description":"For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request."}}}]},"examples":{"Response Example":{"value":{"workbookId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff","workbookUrlId":"57a96EMo3GVJG73179MV2l","name":"My new Workbook","url":"https://example.com/workbooks/88889999-aaaa-bbbb-cccc-ddddeeeeffff","path":"folder1","latestVersion":1,"isArchived":false,"createdAt":"2022-01-01T00:00:00.000Z","createdBy":"user1","updatedAt":"2023-01-01T00:00:00.000Z","updatedBy":"user2","ownerId":"user1"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}":{"get":{"summary":"Get a workbook","description":"This endpoint retrieves a workbook by its unique identifier (`workbookId`). It provides detailed information about the workbook, including its name, URL, path, and other metadata. You can use this endpoint to fetch specific workbook details for display or further processing within client applications.\n\n### Usage notes\n- The **workbookId** parameter must be a valid UUID that uniquely identifies the workbook. Invalid or nonexistent IDs return an error. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n### Usage scenarios\n- **Data retrieval**: Developers can use this endpoint to programmatically retrieve details about a specific workbook to display its content or metadata in a custom user interface.\n- **Integration**: This endpoint is crucial for integrations where other systems need to fetch workbook details based on an ID provided through another interface or workflow.\n\n### Best practices\n- Validate the **workbookId** on the client side before making a request to avoid unnecessary server load caused by invalid requests.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"includeTaggedSourceUrlId","schema":{"type":"boolean","description":"When `true`, returns a URL to the source document for any version-tagged workbook deployed to a tenant organization."},"in":"query"}],"operationId":"getWorkbook","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","required":["workbookId","workbookUrlId","name","url","path","latestVersion","ownerId"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"workbookUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number","description":"The most recently published document version of the workbook."},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","name","sourceWorkbookVersion","taggedWorkbookId","workbookTaggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"name":{"type":"string"},"sourceWorkbookVersion":{"type":"number"},"taggedWorkbookId":{"type":"string","description":"Unique identifier of the tagged workbook.","title":"Workbook ID"},"workbookTaggedAt":{"type":"string","format":"date-time"}}}},"description":{"type":"string"},"taggedSourceUrlId":{"type":"string","description":"For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request."}}}]},{"type":"object","properties":{}}]},"examples":{"Response Example":{"value":{"workbookId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff","workbookUrlId":"57a96EMo3GVJG73179MV2l","name":"My workbook","url":"https://example.com/workbooks/88889999-aaaa-bbbb-cccc-ddddeeeeffff","path":"folder1","latestVersion":1,"createdAt":"2022-01-01T00:00:00.000Z","createdBy":"user1","updatedAt":"2023-01-01T00:00:00.000Z","updatedBy":"user2","ownerId":"user1","isArchived":false,"tags":[{"versionTagId":"11111111-1111-1111-1111-111111111111","name":"My tag","sourceWorkbookVersion":1,"taggedWorkbookId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff","workbookTaggedAt":"2022-02-01T00:00:00.000Z"}],"description":"Describe my workbook"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/agents":{"get":{"summary":"List agents in a workbook (Beta)","description":"List the Sigma agents defined in a workbook.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook to list agents from.","title":"Workbook ID"},"in":"path","required":true},{"name":"versionTagName","schema":{"type":"string","description":"Name of the version tag whose workbook version to list agents from. Omit to list agents from the latest published version.","title":"Tag name"},"in":"query"}],"operationId":"listAgentsInWorkbook","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["agentId","workbookId","agentName"],"properties":{"agentId":{"type":"string","description":"Unique identifier of the agent within a workbook.","title":"Agent ID"},"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"agentName":{"type":["string","null"],"description":"Display name of the agent."}}},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/agents/{agentId}":{"post":{"summary":"Run a Sigma agent (Beta)","description":"Run a Sigma agent and return its reply.\n\n**Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\nThe API is stateless. Include the full conversation in `messages` on every call. To continue a conversation, append the response `output` to your `messages` and send them on the next call. The agent runs with your access against the workbook's latest published version unless you pass `versionTagName`.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **agentId** by calling the [/v2/workbooks/{workbookId}/agents](https://help.sigmacomputing.com/reference/list-agents-in-workbook) endpoint.\n- Retrieve the **versionTagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response. Omit to run against the latest published version.\n- If the `workbookVersion` changes between turns, the workbook was published mid-conversation.\n\n### Usage scenarios\n\n- **Evaluate agent responses**: Include the response `runId` in support requests, and use it to correlate runs with your logs.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook that contains the agent.","title":"Workbook ID"},"in":"path","required":true},{"name":"agentId","schema":{"type":"string","description":"Unique identifier of the Sigma agent to run.","title":"Agent ID"},"in":"path","required":true}],"operationId":"runAgent","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["messages"],"properties":{"messages":{"type":"array","items":{"oneOf":[{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","enum":["user"]},"content":{"oneOf":[{"type":"string","description":"Plain-text shorthand for a single text block.","title":"Text"},{"type":"array","items":{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string","description":"Plain text content included as a message. If sent from a user, the contents of the prompt. If sent from the agent, the contents of the message."}},"description":"A plain-text message.","title":"Text"},"description":"Content as an array of text blocks.","title":"Content blocks"}],"description":"Content of the turn, as plain text or an array of content blocks."}},"description":"A message from the user.","title":"User message"},{"allOf":[{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["assistant"]}}},{"type":"object","properties":{"content":{"type":["string","null"],"description":"The text content generated by the AI assistant. Might be null if the AI assistant only calls tools."},"reasoning":{"type":["string","null"],"description":"The AI assistant's reasoning for this turn, when the model produced any. Informational; it is ignored if sent back in a later request."},"tool_calls":{"type":"array","items":{"type":"object","required":["id","type","function"],"properties":{"id":{"type":"string","description":"Unique identifier for this tool call."},"type":{"type":"string","enum":["function"],"description":"The type of tool call."},"function":{"type":"object","required":["name","arguments"],"properties":{"name":{"type":"string","description":"Name of the tool invoked by the agent."},"arguments":{"type":"string","description":"The tool call arguments, serialized as a JSON object string."}},"description":"Function call details."}},"description":"A tool call made by the AI assistant.","title":"Tool call"},"description":"Tool calls made by the AI assistant."}}}],"description":"A message from the AI assistant.","title":"Assistant message"},{"type":"object","required":["role","tool_call_id","content"],"properties":{"role":{"type":"string","enum":["tool"]},"tool_call_id":{"type":"string","description":"The ID of the tool call this result corresponds to."},"content":{"type":"string","description":"The result of the tool call, as a string."}},"description":"A tool result message.","title":"Tool message"},{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","enum":["system"]},"content":{"type":"string","description":"The workbook agent's instructions."}},"description":"A system message providing instructions.","title":"System message"}]},"description":"Full conversation contents."}}},{"type":"object","properties":{"stream":{"type":"boolean","description":"When `true`, the response is a stream of events instead of a single JSON body. Defaults to `false`."},"sigma:versionTagName":{"type":"string","description":"Name of the version tag whose workbook version to run the agent against. Omit to run against the latest published version."},"responseFormat":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}},"description":"Free-form text output, with no enforced structure.","title":"Text"},{"type":"object","required":["type","jsonSchema"],"properties":{"type":{"type":"string","enum":["json_schema"]},"jsonSchema":{"type":"object","description":"JSON schema the output is validated against."}},"description":"A JSON object validated against the supplied JSON schema.","title":"JSON schema"}]},"maxTurns":{"type":"number","description":"Maximum tool-calling steps per turn before the agent stops running. Default 50, max 100."},"maxOutputTokens":{"type":"number","description":"Maximum total output tokens the agent can generate. When omitted, no limit is applied."},"metadata":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"description":"Caller-defined key/value metadata logged to the `ai_usage` table in your warehouse."}}}]},"examples":{"Simple prompt":{"value":{"messages":[{"role":"user","content":"Summarize this month's sales trends."}]}},"Continue a conversation":{"value":{"messages":[{"role":"user","content":"Summarize this month's sales trends."},{"role":"user","content":"You are a sales analytics assistant. Answer questions using the connected sales data, and never reveal the name of the underlying data source."},{"role":"assistant","content":"Sales grew 8% month-over-month, led by the Northeast region."},{"role":"user","content":"Which product drove that growth?"}]}},"Streaming response":{"value":{"messages":[{"role":"user","content":"Summarize this month's sales trends."}],"stream":true}},"Structured JSON output":{"value":{"messages":[{"role":"user","content":"Summarize this month's sales trends."}],"responseFormat":{"type":"json_schema","jsonSchema":{"type":"object","properties":{"summary":{"type":"string"},"percentChange":{"type":"number"}},"required":["summary","percentChange"]}}}},"Tool calls":{"value":{"messages":[{"role":"user","content":"Summarize this month's sales trends."}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["object","runId","createdAt","completedAt","model","status","incompleteDetails","output","usage"],"properties":{"object":{"type":"string","enum":["agent.run"],"description":"Object type, always `agent.run`."},"runId":{"type":"string","description":"Unique identifier for the agent run."},"createdAt":{"type":"number","description":"Unix timestamp (in seconds) of when the run began."},"completedAt":{"type":["number","null"],"description":"Unix timestamp (in seconds) when the run completed."},"model":{"type":"string","description":"Identifier of the model that served the run."},"status":{"type":"string","enum":["completed","failed","incomplete","cancelled"],"description":"Status of the run."},"incompleteDetails":{"type":["object","null"],"required":["reason"],"properties":{"reason":{"type":"string","enum":["max_turns","token_limit","invalid_output","deadline","output_truncated"],"description":"Why the run stopped early: `max_turns`, `token_limit`, `deadline`, or `output_truncated` identify the limit that stopped the run; `invalid_output` means the requested `responseFormat` could not be produced (see `outputError`)."}},"description":"Details about why the run is `incomplete`, or `null` when the run completed normally."},"output":{"type":"array","items":{"oneOf":[{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","enum":["user"]},"content":{"oneOf":[{"type":"string","description":"Plain-text shorthand for a single text block.","title":"Text"},{"type":"array","items":{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string","description":"Plain text content included as a message. If sent from a user, the contents of the prompt. If sent from the agent, the contents of the message."}},"description":"A plain-text message.","title":"Text"},"description":"Content as an array of text blocks.","title":"Content blocks"}],"description":"Content of the turn, as plain text or an array of content blocks."}},"description":"A message from the user.","title":"User message"},{"allOf":[{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["assistant"]}}},{"type":"object","properties":{"content":{"type":["string","null"],"description":"The text content generated by the AI assistant. Might be null if the AI assistant only calls tools."},"reasoning":{"type":["string","null"],"description":"The AI assistant's reasoning for this turn, when the model produced any. Informational; it is ignored if sent back in a later request."},"tool_calls":{"type":"array","items":{"type":"object","required":["id","type","function"],"properties":{"id":{"type":"string","description":"Unique identifier for this tool call."},"type":{"type":"string","enum":["function"],"description":"The type of tool call."},"function":{"type":"object","required":["name","arguments"],"properties":{"name":{"type":"string","description":"Name of the tool invoked by the agent."},"arguments":{"type":"string","description":"The tool call arguments, serialized as a JSON object string."}},"description":"Function call details."}},"description":"A tool call made by the AI assistant.","title":"Tool call"},"description":"Tool calls made by the AI assistant."}}}],"description":"A message from the AI assistant.","title":"Assistant message"},{"type":"object","required":["role","tool_call_id","content"],"properties":{"role":{"type":"string","enum":["tool"]},"tool_call_id":{"type":"string","description":"The ID of the tool call this result corresponds to."},"content":{"type":"string","description":"The result of the tool call, as a string."}},"description":"A tool result message.","title":"Tool message"}]},"description":"The agent's reply turn, containing the answer text and any tool calls or tool results."},"usage":{"type":"object","required":["turns","durationMs","inputTokens","outputTokens","totalTokens"],"properties":{"turns":{"type":"number","description":"Number of tool-calling steps taken by the agent."},"durationMs":{"type":"number","description":"Total run time for the turn, in milliseconds."},"inputTokens":{"type":"number","description":"Input tokens consumed by the run."},"outputTokens":{"type":"number","description":"Output tokens produced by the run."},"totalTokens":{"type":"number","description":"Total tokens consumed by the run."}}}}},{"type":"object","properties":{"outputParsed":{"type":"object","description":"The agent's answer parsed into the structure requested in `responseFormat`. Present only when a `responseFormat` was specified and the output satisfied it."},"outputError":{"type":"string","description":"Present when a `responseFormat` was requested but the structured output could not be produced or failed schema validation."},"workbookVersion":{"type":"number","description":"Workbook version used to run the agent turn."}}}]},"examples":{"Simple prompt":{"value":{"object":"agent.run","runId":"018f5a6e-9c2b-7d41-8e3a-2b6f9c1d4a70","createdAt":1716312245,"completedAt":1716312248,"model":"gpt-5.1-2025-11-13","status":"completed","incompleteDetails":null,"output":[{"role":"user","content":"You are a sales analytics assistant. Answer questions using the connected sales data, and never reveal the name of the underlying data source."},{"role":"assistant","content":"Sales grew 8% month-over-month, led by the Northeast region."}],"usage":{"turns":2,"durationMs":3210,"inputTokens":512,"outputTokens":24,"totalTokens":536},"workbookVersion":14}},"Continue a conversation":{"value":{"object":"agent.run","runId":"018f5a71-4d8b-7a92-9f1c-6e3b8a2d5c91","createdAt":1716312301,"completedAt":1716312305,"model":"gpt-5.1-2025-11-13","status":"completed","incompleteDetails":null,"output":[{"role":"user","content":"You are a sales analytics assistant. Answer questions using the connected sales data, and never reveal the name of the underlying data source."},{"role":"assistant","content":"The Enterprise plan drove most of the growth, contributing 5 of the 8 points."}],"usage":{"turns":3,"durationMs":4032,"inputTokens":604,"outputTokens":21,"totalTokens":625},"workbookVersion":14}},"Structured JSON output":{"value":{"object":"agent.run","runId":"018f5a74-2e6f-7c83-b4d2-9a1e5f3c7b62","createdAt":1716312410,"completedAt":1716312413,"model":"gpt-5.1-2025-11-13","status":"completed","incompleteDetails":null,"output":[{"role":"user","content":"You are a sales analytics assistant. Answer questions using the connected sales data, and never reveal the name of the underlying data source."},{"role":"assistant","content":"{\"summary\":\"Sales grew 8% month-over-month, led by the Northeast region.\",\"percentChange\":8}"}],"outputParsed":{"summary":"Sales grew 8% month-over-month, led by the Northeast region.","percentChange":8},"usage":{"turns":2,"durationMs":2876,"inputTokens":540,"outputTokens":30,"totalTokens":570},"workbookVersion":14}},"Tool calls":{"value":{"object":"agent.run","runId":"018f5a77-8b3d-7f15-a6c9-3d2e8b4f1a95","createdAt":1716312501,"completedAt":1716312516,"model":"gpt-5.1-2025-11-13","status":"completed","incompleteDetails":null,"output":[{"role":"user","content":"You are a sales analytics assistant. Answer questions using the connected sales data, and never reveal the name of the underlying data source."},{"role":"assistant","tool_calls":[{"id":"call_9qFY3EaBsBb0uJh0rqXvVsED","type":"function","function":{"name":"database_execute_query","arguments":"{\"query\":\"SELECT region, SUM(revenue) AS revenue FROM sales GROUP BY region ORDER BY revenue DESC LIMIT 5\"}"}}]},{"role":"tool","tool_call_id":"call_9qFY3EaBsBb0uJh0rqXvVsED","content":"[{\"region\":\"Northeast\",\"revenue\":482000},{\"region\":\"West\",\"revenue\":401500},{\"region\":\"Midwest\",\"revenue\":312800},{\"region\":\"South\",\"revenue\":298100},{\"region\":\"Southeast\",\"revenue\":210400}]"},{"role":"assistant","content":"Sales grew 8% month-over-month, led by the Northeast region."}],"usage":{"turns":3,"durationMs":15239,"inputTokens":16700,"outputTokens":654,"totalTokens":17354},"workbookVersion":14}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/bookmarks":{"get":{"summary":"List bookmarks in a workbook","description":"Returns a list of available bookmarks in a workbook. Available bookmarks are those that you have created or that have been shared with you.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n### Usage scenarios\n- **Maintenance and governance**: Review workbook bookmarks for usage, validity, and freshness.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getWorkbookBookmarks","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["bookmarkId","name","isShared","exploreKey"],"properties":{"bookmarkId":{"type":"string"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}},{"type":"object","properties":{"isDefault":{"type":"boolean","description":"Whether the bookmark is default."}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"post":{"summary":"Add a saved view to a workbook","description":"Add a saved view (formerly known as bookmarks) to a workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **workbookVersion** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version.\n- Retrieve the **exploreKey** by identifying the ID of the custom view that you want to save as a saved view (formerly known as bookmarks). When exploring a workbook, the explore key is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.\n\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"postWorkbookBookmarks","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["workbookVersion","name","isShared","exploreKey"],"properties":{"workbookVersion":{"type":"number"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["bookmarkId","name","isShared","exploreKey"],"properties":{"bookmarkId":{"type":"string"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}},{"type":"object","properties":{"isDefault":{"type":"boolean","description":"Whether the bookmark is default."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/bookmarks/{bookmarkId}":{"get":{"summary":"Get a bookmark","description":"Retrieve details of a workbook bookmark.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"bookmarkId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"getWorkbookBookmark","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["bookmarkId","name","isShared","exploreKey"],"properties":{"bookmarkId":{"type":"string"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}},{"type":"object","properties":{"isDefault":{"type":"boolean","description":"Whether the bookmark is default."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"patch":{"summary":"Update a workbook bookmark","description":"Update a workbook bookmark, for example by updating the bookmark to use a new exploration of the workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n- Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"bookmarkId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateWorkbookBookmark","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":["string","null"]},"isShared":{"type":["boolean","null"]},"isDefault":{"type":["boolean","null"]},"exploreKey":{"type":["string","null"],"description":"ID of the associated exploration."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["bookmarkId","name","isShared","exploreKey"],"properties":{"bookmarkId":{"type":"string"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}},{"type":"object","properties":{"isDefault":{"type":"boolean","description":"Whether the bookmark is default."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"delete":{"summary":"Delete a bookmark from a workbook","description":"Delete a bookmark from a workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"bookmarkId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteWorkbookBookmarks","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/columns":{"get":{"summary":"List columns for all elements in a workbook","description":"This endpoint retrieves all columns in a workbook for all element in the workbook.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n  ### Usage scenarios\n  - **Data exploration:** Enable users to explore the data structure of a workbook element, facilitating deeper analysis and understanding.\n  - **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately.\n\n  ### Best practices\n  - Use this endpoint when setting up interfaces that require specific knowledge about the data structure.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getWorkbookColumns","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["columnId","name","formula","type","elementId"],"properties":{"columnId":{"type":"string","description":"Column ID"},"name":{"type":"string","description":"Column name"},"formula":{"type":"string","description":"Column formula or source column reference."},"type":{"type":"object","description":"The column's data type, represented as a recursive type object."},"elementId":{"type":"string","description":"Element ID"}}}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]},"examples":{"Response Example":{"value":{"entries":[{"columnId":"cWoHPEQoiG","label":"City","formula":"[STATIONS/City]","elementId":"4eJb2QhzOm"},{"columnId":"RyThlKefu","label":"Dock Count","formula":"[STATIONS/Dock Count]","elementId":"4eJb2QhzOm"},{"columnId":"ffARyThlK","label":"Name","formula":"[STATIONS/Name]","elementId":"4eJb2QhzOm"}],"nextPage":null}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/controls":{"get":{"summary":"List workbook controls","description":"This endpoint retrieves all controls associated with a specific workbook. Controls are interactive elements like checkboxes, or dropdowns used within the workbook for dynamic data interaction.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n### Usage scenarios\n- **Dynamic data interaction:** Allows users to interact dynamically with the data presented in the workbook through various control mechanisms.\n- **Custom reporting:** Enables the creation of customizable reports where end users can adjust parameters to filter and sort data according to their requirements.\n\n### Best practices\n- Ensure proper access controls are set to manage who can view or interact with the controls to prevent unauthorized data manipulation.\n- Use detailed and descriptive names for controls to facilitate easier identification and use by end users.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getWorkbookControls","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["name","valueType"],"properties":{"name":{"type":"string"},"valueType":{"oneOf":[{"type":"string","enum":["boolean"]},{"type":"string","enum":["number"]},{"type":"string","enum":["text"]},{"type":"string","enum":["date"]},{"type":"string","enum":["number-list"]},{"type":"string","enum":["text-list"]},{"type":"string","enum":["date-list"]},{"type":"string","enum":["boolean-list"]},{"type":"string","enum":["date-range"]},{"type":"string","enum":["number-range"]},{"type":"string","enum":["date-null"]},{"type":"string","enum":["number-null"]},{"type":"string","enum":["text-null"]},{"type":"string","enum":["boolean-null"]}],"description":"Value of the control"}}}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/convertToReport":{"post":{"summary":"Convert a workbook to a report","description":"This endpoint converts an existing workbook into a new report. When you convert a workbook, the existing workbook is not modified. Elements and functionality in the workbook that are not supported in reports are listed in a `warnings` array in the response. Unsupported workbook contents are either removed (not added to the new report) or, if supported contents depend on them, are added to a hidden page at the end of the report.\n    See [Limitations and unsupported elements](https://help.sigmacomputing.com/docs/convert-workbooks-to-reports#limitations-and-unsupported-elements).\n\n    You can also convert a workbook to a report from the UI. See [Convert workbooks to reports](https://help.sigmacomputing.com/docs/convert-workbooks-to-reports).\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- The **name** parameter is required.\n- Use **destinationFolderId** to choose where to save the report. If not provided, the report is saved to your **My Documents** folder.\n- Use **pageIds** to convert only specific workbook pages. If not provided, the entire workbook is converted.\n- Use **format** to set the page size and orientation. The default size is letter, and the default orientation is portrait.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"convertWorkbookToReport","requestBody":{"description":"Body parameters for converting a workbook to a report.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name for the new report.","title":"Report name"}}},{"type":"object","properties":{"destinationFolderId":{"type":"string","description":"ID of the folder in which to create the new report. Defaults to your \"My Documents\" folder.","title":"Destination Folder ID"},"description":{"type":"string","description":"A description for the new report.","title":"Description"},"pageIds":{"type":"array","items":{"type":"string"},"description":"IDs of the workbook pages to convert. Defaults to the entire workbook.","title":"Page IDs"},"format":{"oneOf":[{"allOf":[{"type":"object","required":["pageSize"],"properties":{"pageSize":{"type":"string","enum":["letter","a4","legal","a3"],"description":"A standard page-size preset.","title":"Page size"}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"],"description":"Page orientation. Defaults to `portrait`.","title":"Layout"}}}],"description":"A standard page-size preset (letter, a4, legal, or a3).","title":"Preset format"},{"type":"object","required":["pageSize","unit","width","height"],"properties":{"pageSize":{"type":"string","enum":["custom"],"description":"Use a custom page size.","title":"Custom page size"},"unit":{"type":"string","enum":["pixels","inches","centimeters"],"description":"Unit for the `width` and `height` values.","title":"Unit"},"width":{"type":"number","description":"Page width, in the given unit.","title":"Width"},"height":{"type":"number","description":"Page height, in the given unit.","title":"Height"}},"description":"A custom page size, in pixels, inches, or centimeters.","title":"Custom format"}],"description":"Page size and orientation for the report. Defaults to letter portrait.","title":"Format"}}}],"description":"Body parameters for converting a workbook to a report."}}}},"responses":{"201":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["convertedReport","sourceWorkbook","warnings"],"properties":{"convertedReport":{"allOf":[{"type":"object","required":["reportId","reportUrlId","name","url","path","latestVersion","ownerId"],"properties":{"reportId":{"type":"string","description":"Unique identifier of the report.","title":"Report ID"},"reportUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number"},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"allOf":[{"type":"object","required":["versionTagId","tagName","sourceVersion","taggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"tagName":{"type":"string"},"sourceVersion":{"type":"number"},"taggedAt":{"type":"string","format":"date-time"}}},{"type":"object","required":["taggedReportId"],"properties":{"taggedReportId":{"type":"string","description":"Unique identifier of the tagged report.","title":"Report ID"}}}]}},"description":{"type":"string"}}}]},"sourceWorkbook":{"type":"object","required":["workbookId","name","url"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the source workbook.","title":"Workbook ID"},"name":{"type":"string","description":"Name of the source workbook.","title":"Workbook name"},"url":{"type":"string","description":"URL of the source workbook.","title":"Workbook URL"}}},"warnings":{"type":"array","items":{"allOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable warning code, in kebab-case. Treat this as an open set and handle unknown codes gracefully.","title":"Code"},"message":{"type":"string","description":"Human-readable explanation of the warning.","title":"Message"}}},{"type":"object","properties":{"details":{"type":"array","items":{"allOf":[{"type":"object","required":["type","count"],"properties":{"type":{"type":"string","description":"Element type, in kebab-case.","title":"Type"},"count":{"type":"number","description":"Number of affected elements of this type.","title":"Count"}}},{"type":"object","properties":{"sourceElementIds":{"type":"array","items":{"type":"string"},"description":"IDs of the affected elements in the source workbook.","title":"Source element IDs"},"reportElementIds":{"type":"array","items":{"type":"string"},"description":"IDs of the affected elements in the new report.","title":"Report element IDs"},"parent":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","description":"Unsupported parent type, in kebab-case (e.g. `sidebar-panel`, `repeater`, `modal`).","title":"Parent type"},"id":{"type":"string","description":"ID of the unsupported parent in the source workbook.","title":"Parent ID"}},"description":"The unsupported parent that caused this element to drop, if applicable.","title":"Parent"}}}]},"description":"Per-element details for this warning, when available.","title":"Details"}}}]},"description":"Warnings about content that could not be carried over to the report. May be empty.","title":"Warnings"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/copy":{"post":{"summary":"Duplicate a workbook","description":"This endpoint lets you duplicate an existing workbook. The workbook copy can be placed in a different folder from the original workbook, potentially with a different name and description. This is useful for creating workbook templates or backups.\n\n### Usage notes\n- The `workbookId` in the URL specifies the original workbook to be copied. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- The `destinationFolderId` in the request body specifies where to place the new workbook.\n\n  - To use the \"My Documents\" folder for a specific user as the destination folder, call the [/v2/members/{memberId}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response.\n  - Retrieve the **folderId** of all folders by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n\n### Usage scenarios\n- **Reuse**: Use an existing workbook as a baseline for a \"one-off\" purpose instead of a template.\n- **Template creation**: Create a copy of a workbook to serve as a template for future projects.\n- **Backup**: Make a backup of a workbook before making significant changes. [Version tagging](https://help.sigmacomputing.com/docs/version-tagging) is also a useful way to accomplish this.\n\n### Best practices\n- Always verify that the destination folder has the correct permissions set to avoid access issues.\n- When using as a template, ensure that all data connections are correctly configured to prevent data leaks or errors.\n\n### Copying bookmarks\n- Set `copyBookmarks` to `all` to copy every saved view (formerly \"bookmarks\") applied to the source workbook. This is available to admins only.\n- Set `copyBookmarks` to `accessible` to copy personal saved views and those shared with the user initiating the operation.\n- Ownership of all copied bookmarks transfers to the user initiating the copy operation.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"copyWorkbook","requestBody":{"description":"Body parameters for copying a workbook.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["destinationFolderId","name"],"properties":{"destinationFolderId":{"type":"string","description":"ID of the folder in which to place the copied workbook.","title":"Destination Folder ID"},"name":{"type":"string","description":"Name for the copied workbook as it appears in Sigma.","title":"New Workbook Name"}}},{"type":"object","properties":{"description":{"type":"string","description":"A description for the new workbook.","title":"New Description"},"copyBookmarks":{"type":"string","enum":["all","accessible"],"description":"If set to `all` (available to admins only), every saved view (bookmark) applied to the workbook is copied. If set to `accessible`, only personal saved views and those shared with the user initiating the operation are copied. Ownership of all saved views in the duplicate workbook transfers to the user initiating the operation. If not set, saved views are not copied.","title":"Copy Bookmarks"}}}],"description":"Body parameters for copying a workbook."}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["workbookId","workbookUrlId","name","url","path","latestVersion","ownerId"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"workbookUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number","description":"The most recently published document version of the workbook."},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","name","sourceWorkbookVersion","taggedWorkbookId","workbookTaggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"name":{"type":"string"},"sourceWorkbookVersion":{"type":"number"},"taggedWorkbookId":{"type":"string","description":"Unique identifier of the tagged workbook.","title":"Workbook ID"},"workbookTaggedAt":{"type":"string","format":"date-time"}}}},"description":{"type":"string"},"taggedSourceUrlId":{"type":"string","description":"For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/elements":{"get":{"summary":"List elements in a workbook","description":"This endpoint retrieves all elements in a workbook, which lets you understand and interact with the individual components that make up the workbook, such as charts, tables, or controls.\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- To retrieve elements from version-tagged workbooks, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `tags.name` included in the response for a given workbook.\n- To retrieve elements from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoints.\n### Usage scenarios\n- **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation.\n- **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with.\n### Best practices\n- Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience.\n- Validate both the workbookId and pageId to ensure they correspond to valid, accessible resources before making API calls.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"tagName","schema":{"type":"string"},"in":"query"},{"name":"bookmarkId","schema":{"type":"string","description":"Unique identifier of the bookmark.","title":"Bookmark ID"},"in":"query"}],"operationId":"listWorkbookElements","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"columns":{"type":"array","items":{"type":"string"}},"vizualizationType":{"type":"string"},"error":{"type":"string"}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/elements/{elementId}/columns":{"get":{"summary":"List columns for a workbook element","description":"This endpoint retrieves a list of columns associated with a specific element within a workbook. It provides metadata about each column, such as name and formula, which can be essential for understanding the data structure and for further data manipulation or analysis.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.\n\n  ### Usage scenarios\n  - **Data exploration:** Helps users to explore the data structure of a workbook element, facilitating deeper analysis and understanding.\n  - **Integration tasks:** Useful for developers integrating Sigma with other tools, needing to know the data structure to map data accurately.\n\n  ### Best practices\n  - Validate the elementId to make sure it corresponds to the correct workbook element before querying.\n  - Leverage this endpoint when setting up interfaces that require specific knowledge about the data structure.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the workbook element.","title":"Element ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getElementColumns","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["columnId","label","formula","type"],"properties":{"columnId":{"type":"string","description":"Column ID"},"label":{"type":"string","description":"Column name"},"formula":{"type":"string","description":"Column formula"},"type":{"type":"object","description":"The column's data type, represented as a recursive type object."}}}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules":{"post":{"summary":"Create a materialization schedule for a workbook element (Beta)","description":"This endpoint creates a materialization schedule for an element in a workbook. The scheduled run materializes the element's data on the given cadence, allowing the data to be stored or cached for optimized access and performance.\n\n  For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n  **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Retrieve the **elementId** by calling the [/v2/workbooks/{workbookId}/elements](https://help.sigmacomputing.com/reference/list-workbook-elements) endpoint.\n  - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.\n  - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.\n  - An element can have at most one materialization schedule.\n  - The materialization run starts immediately upon creation using the latest published version of the workbook.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Identifier of the workbook element to materialize on a schedule. Must be an element, such as a table or visualization, that can be materialized.","title":"Element ID"},"in":"path","required":true}],"operationId":"createMaterializationSchedule","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["schedule"],"properties":{"schedule":{"allOf":[{"type":"object","required":["cronSpec"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."}}},{"type":"object","properties":{"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. Defaults to the organization timezone."}}}],"description":"When to run the materialization.","title":"Schedule"}}}}}},"responses":{"201":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["sheetId","elementId","elementName","schedule","configuredAt","paused"],"properties":{"sheetId":{"type":"string","description":"Identifier of the materialization schedule for the element","title":"Sheet ID"},"elementId":{"type":"string","description":"Identifier of the element being materialized","title":"Element ID"},"elementName":{"type":"string"},"schedule":{"type":["object","null"],"properties":{"cronSpec":{"type":"string","description":"Cron expression to use for the schedule"},"timezone":{"type":"string","description":"Timezone code, for example, PST"}}},"configuredAt":{"type":"string","format":"date-time"},"paused":{"type":"boolean"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"patch":{"summary":"Update a materialization schedule for a workbook element (Beta)","description":"This endpoint updates the schedule cadence and/or timezone of an existing materialization schedule for an element in a workbook.\n  For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n  **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Retrieve the **elementId** by calling the [/v2/workbooks/{workbookId}/elements](https://help.sigmacomputing.com/reference/list-workbook-elements) endpoint.\n  - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.\n  - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.\n  - The workbook element must already have a materialization schedule. To create one, call the [/v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules](https://help.sigmacomputing.com/reference/create-materialization-schedule) endpoint.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Identifier of the workbook element to materialize on a schedule. Must be an element, such as a table or visualization, that can be materialized.","title":"Element ID"},"in":"path","required":true}],"operationId":"patchMaterializationSchedule","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["schedule"],"properties":{"schedule":{"allOf":[{"type":"object","required":["cronSpec"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."}}},{"type":"object","properties":{"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. Defaults to the organization timezone."}}}],"description":"When to run the materialization.","title":"Schedule"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["sheetId","elementId","elementName","schedule","configuredAt","paused"],"properties":{"sheetId":{"type":"string","description":"Identifier of the materialization schedule for the element","title":"Sheet ID"},"elementId":{"type":"string","description":"Identifier of the element being materialized","title":"Element ID"},"elementName":{"type":"string"},"schedule":{"type":["object","null"],"properties":{"cronSpec":{"type":"string","description":"Cron expression to use for the schedule"},"timezone":{"type":"string","description":"Timezone code, for example, PST"}}},"configuredAt":{"type":"string","format":"date-time"},"paused":{"type":"boolean"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"delete":{"summary":"Delete a materialization schedule for a workbook element (Beta)","description":"This endpoint deletes the materialization schedule for an element in a workbook. Any subsequent scheduled materialization runs for the element are cancelled.\n  For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n  **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Retrieve the **elementId** by calling the [/v2/workbooks/{workbookId}/elements](https://help.sigmacomputing.com/reference/list-workbook-elements) endpoint.\n  - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.\n  - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.\n  - The workbook element must already have a materialization schedule.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Identifier of the workbook element to materialize on a schedule. Must be an element, such as a table or visualization, that can be materialized.","title":"Element ID"},"in":"path","required":true}],"operationId":"deleteMaterializationSchedule","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/elements/{elementId}/query":{"get":{"summary":"Get the SQL query for a workbook element","description":"This endpoint retrieves the SQL query associated with a specific element in a workbook. It allows users to view and understand how the data for that element is being processed and transformed, which is critical for debugging, optimization, and educational purposes.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **elementId** for a custom SQL element by calling the [/v2/workbooks/{workbookId}/queries](https://help.sigmacomputing.com/reference/list-workbook-queries) endpoint.\n- To retrieve the query for an element from a version-tagged workbook, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `tags.name` included in the response for a given workbook.\n- To retrieve the query for an element from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoints.\n\n### Usage scenarios\n- **Development and debugging:** Provides developers and analysts with the ability to retrieve and review the SQL code behind workbook elements, facilitating troubleshooting and enhancements.\n- **Educational insight:** Useful for training purposes or for users learning to understand the impact of various transformations and filters applied within their Sigma workbooks.\n\n### Best practices\n- Ensure proper access controls are in place to manage who can view potentially sensitive query information.\n- Use this endpoint as part of a regular review process to ensure that all queries are optimized and up to date with current data schemas.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the workbook element.","title":"Element ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"tagName","schema":{"type":"string"},"in":"query"},{"name":"bookmarkId","schema":{"type":"string"},"in":"query"}],"operationId":"getElementQuery","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"sql":{"type":"string"},"error":{"type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/embeds":{"get":{"summary":"Get embeds for a workbook","description":"This endpoint retrieves the list of available embeds for a specific workbook. The response provides the embedUrl and indicates whether an embed is public.\n\n### Usage notes\n- The endpoint requires the `workbookId` as a path parameter to identify the workbook. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n### Usage scenarios\n- **Integration with third-party applications:** Developers can use this endpoint to list embeds that integrate workbook content into third-party applications, enhancing functionality or providing customized views.\n- **Internal dashboards:** Teams within an organization can embed workbook content into internal dashboards to monitor real-time data and analytics from various workbooks without directly accessing Sigma.\n\n### Best practices\n- Ensure that the embeds are used in compliance with data governance and privacy policies.\n- Regularly review and manage the access permissions for each embed to prevent unauthorized data exposure.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listWorkbookEmbeds","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["embedId","embedUrl","public","sourceType","sourceId","sourceName"],"properties":{"embedId":{"type":"string","description":"Unique identifier of the embed.","title":"Embed ID"},"embedUrl":{"type":"string"},"public":{"type":"boolean"},"sourceType":{"type":"string","enum":["workbook","page","element"]},"sourceId":{"type":["string","null"]},"sourceName":{"type":["string","null"]}}},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"post":{"summary":"Create an embed for a workbook","description":"This endpoint lets you create an embed for a specific workbook. You can embed an entire workbook, a specific page, or an individual element within a workbook. Embedding enables seamless integration of Sigma content into other applications, websites, or internal platforms, providing a flexible and dynamic way to present and interact with data.\n\n### Embedding options\n\n- Publicly embed Sigma in a public website by creating an embed of type `public`.\n- Securely embed Sigma in an authenticated host application.\n\n  - (Recommended) Use JSON Web Tokens (JWT) to sign the workbook URL outputted by the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint instead of the output of this endpoint. See [Create a secure embed](/docs/create-a-secure-embed).\n  - (Deprecated) Use this endpoint to create an embed of type `secure`. This option is deprecated. See [Migrate to JWT-signed secure embed URLs](/docs/migrate-to-jwt-signed-secure-embed-urls).\n\n### Usage notes\n- The endpoint requires the workbookId as a path parameter. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- The body of the request must specify the type of embed (public).\n- You must specify the source type (workbook, page, element) and ID for that source to create the embed.\n\n  - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint.\n  - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.\n\n### Usage scenarios\n- **Web application integration:** Developers can use this API to generate the embed URL for integration into their application or for display on a public-facing webpage.\n\n### Best practices\n- Validate the `workbookId` and `sourceId` to ensure they refer to existing resources before attempting to create an embed.\n- Consider the security settings of the embed type to match the integration context, ensuring that data exposure is controlled and appropriate for the audience.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"createWorkbookEmbed","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["embedType","sourceType"],"properties":{"embedType":{"type":"string","enum":["public"],"description":"Defines the visibility and access control of the embed. Choose `public` for open access.","title":"Embed Type"},"sourceType":{"type":"string","enum":["workbook","page","element"],"description":"Specifies the scope of the embed: \"workbook\" for the entire workbook, \"page\" for a single page, or \"element\" for a specific element within the workbook.","title":"Source Type"}}},{"type":"object","properties":{"sourceId":{"type":"string","description":"The specific identifier for the page or element to be embedded if the sourceType is \"page\" or \"element\".","title":"Source ID"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["embedId","embedUrl"],"properties":{"embedId":{"type":"string","description":"Unique identifier of the embed.","title":"Embed ID"},"embedUrl":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/embeds/{embedId}":{"delete":{"summary":"Delete an embed from a workbook","description":"This endpoint lets you delete an embed associated with a specific workbook. It is useful for cleaning up unnecessary or outdated embeds to maintain a streamlined environment.\n\n  ### Usage Notes\n  - Requires `workbookId` and `embedId` as path parameters to specify which embed to delete.\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Retrieve the **embedId** by calling the [/v2/workbooks/{workbookId}/embeds](https://help.sigmacomputing.com/reference/list-workbook-embeds) endpoint.\n\n  ### Usage Scenarios\n  - **Maintenance**: Regularly remove unused or expired embeds to keep your Sigma environment clean and efficient.\n\n  ### Best Practices\n  - Confirm the usage and necessity of an embed before deletion to avoid disrupting dependent services or applications.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"embedId","schema":{"type":"string","description":"Unique identifier of the embed.","title":"Embed ID"},"in":"path","required":true}],"operationId":"deleteWorkbookEmbeds","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/export":{"post":{"summary":"Export data from a workbook","description":"This endpoint lets you create a file containing data exported from a workbook, allowing you to retrieve large sets of data in a structured format. Export the entire workbook, a single workbook page, or an individual element. You can specify parameters to filter the data and format options for the file.\n\nDifferent file formats, including CSV, PDF, JSON, and others,  are supported for different export choices. See [Send or schedule workbook exports](/docs/send-or-schedule-workbook-exports) for details on supported formats for different types of exports.\n\nSuccessful requests to the endpoint return a queryId. Use the **queryId** with the [/v2/query/{queryId}/download](https://help.sigmacomputing.com/reference/download-query) endpoint to download the requested file when it is ready. See [Download an exported file](https://help.sigmacomputing.com/reference/download-query).\n\n## Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- This endpoint is rate limited to 400 requests per minute.\n- This endpoint exports up to 1 million rows for CSV/XLSX/JSON file formats. You can export more rows if you batch your requests in chunks of up to 1 million rows. Use the `rowLimit` parameter to specify the size of the chunk and the `offset` parameter to specify the row to start the next chunk from. For example, if you specify a rowLimit of 2500, to export the next chunk of 2500 rows, specify an offset of 2501. The order of the data matches the order in the data element when the request is made, so there is a possibility of data overlap between requests.\n- For security and privacy reasons, the `queryId` used to download the exported data expires 1 hour after your request is received and the file becomes available to download. You can extend this default expiration to 6 hours using the `resultsValidityTimeMs` request parameter.\n- When exporting a PNG file, the `pixelWidth` and `pixelHeight` parameters are respected on a best effort basis and the output might not match the requested dimensions.\n\n## Usage scenarios\n- Conditional workbook export: Based on an external set of conditions, export a workbook from Sigma.\n- Data analysis: Export specific sets of data for offline analysis, leveraging tools that might not connect directly to a data warehouse.\n- Integration: Integrate enriched and analyzed data with other applications, providing the necessary data in a format that these applications can process.\n\n## Best practices\n- Clearly specify parameters to retrieve only the necessary data, optimizing performance and reducing network load.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"exportWorkbook","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"oneOf":[{"type":"object","required":["elementId","format"],"properties":{"elementId":{"type":"string"},"format":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv","jsonl","json","xlsx"]}},"description":"Export options for csv, json, jsonl, xlsx","title":"Export options for csv, json, jsonl, xlsx"},{"type":"object","required":["type","layout"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"type":"string","enum":["portrait","landscape"]}},"description":"Export options for PDF","title":"Export options for PDF"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}},{"type":"object","properties":{"pixelWidth":{"type":"number"},"pixelHeight":{"type":"number"}}}],"description":"Export options for PNG","title":"Export options for PNG"}]}},"description":"Export a specific element","title":"Export element"},{"type":"object","required":["pageId","format"],"properties":{"pageId":{"type":"string","description":"Identifier of the workbook page."},"format":{"oneOf":[{"type":"object","required":["type","layout"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"type":"string","enum":["portrait","landscape"]}},"description":"Export options for PDF documents","title":"Export options for PDF documents"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}},{"type":"object","properties":{"pixelWidth":{"type":"number"},"pixelHeight":{"type":"number"}}}],"description":"Export options for PNG documents","title":"Export options for PNG documents"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["xlsx"]}},"description":"Export options for EXCEL documents","title":"Export options for EXCEL documents"}]}},"description":"Export a page of a workbook","title":"Export a page of a workbook"},{"type":"object","required":["format"],"properties":{"format":{"oneOf":[{"type":"object","required":["type","layout"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"type":"string","enum":["portrait","landscape"]}},"description":"Export options for PDF documents","title":"Export options for PDF documents"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["xlsx"]}},"description":"Export options for EXCEL documents","title":"Export options for EXCEL documents"}]}},"description":"Export an entire workbook","title":"Export an entire workbook"}]},{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value.\n\n**Syntax**\n{ control-id: control-value }\n\nThe control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.\n\nValues can take multiple forms, depending on the data type of the control:\n\n**Boolean**\n\n- Single value: \"true\" | \"false\" | \":null\"\n- List of Boolean: \"true,false,:null\" (No space after the comma.)\n\n**Number**\n\n- Single value: \"10.54\", \":null\"\n- List of values: \"10.54,23.45,:null\" (No space after the comma.)\n- Range of numbers: \"min:10.54,max:23.45\" (No space after the comma or colon.)\n\n**Text**\n\n- Single value: \"some-text\" | \":null\" | \":empty\"\n- List of values: \"some-text,more-text,:null,:empty\" (No space after the comma.)\n\n**Date**\n\nAll dates use UTC time zones.\n\n- Fixed date using ISO-6801 format: \"2022-01-01T01:01:59\" | \":null\"\n    - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):\n        - %Y-%m-%d\n        - %Y-%m-%dT%H:%M\n        - %Y-%m-%dT%H:%M:%S\n- List of fixed dates: \"2022-01-01T01:01:59,2022-02-02T02:02:59,:null\"\n- Relative date: \"prior-day-3\" | \"next-day-3\"\n    - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]\n- Date range: \"min:2022-01-01T01:01:59,max:next-day-3\" (No spaces after the comma or colon.)\n    - Leave max blank for \"on or after\" and min blank for \"on or before\", for example:\n        - \"Date-Range\": \"min:2020-04-01,max:\"\n        - \"Date-Range\": \"min:,max:next-day-3\"\n\n**Notes**\n\n- \":null\" is a special value that denotes the null primitive value.\n- \":empty\" is a special value that denotes the empty string \"\".\n\nUse [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.\n\nFor example:\n\"New York, NY,Boston, MA\" can be encoded as:\n\n\"New%20York%2C%20NY,Boston%2C%20MA\""},"timeout":{"type":"number","description":""},"tag":{"type":"string","description":"Specifies the version tag of the workbook to be exported."},"exportAs":{"type":"string","description":"Specifies the user ID of the Sigma user to run the export queries as, such as to enforce row-level security. Not supported for users who access Sigma with OAuth."},"rowLimit":{"type":"number","description":"Total number of rows to limit a CSV/XLSX/JSON-formatted export to. "},"offset":{"type":"number","description":"The offset number of rows for a CSV/XLSX/JSON-formatted export to start from. "}}}]},"examples":{"Request Example":{"value":{"elementId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff","format":{"type":"csv"},"timeout":5,"tag":"my-tag","exportAs":"myUserId","parameters":{"param":"value"},"rowLimit":1000,"offset":0}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["jobComplete","queryId"],"properties":{"jobComplete":{"type":"boolean"},"queryId":{"type":"string"}}},{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","additionalProperties":{}}},"message":{"type":"string"}}}]},"examples":{"Export Success":{"value":{"jobComplete":false,"rows":"[Array]","queryId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff"}},"Export Failure":{"value":{"jobComplete":false,"message":"Export finished at 1600000000000","queryId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff"}},"Export Incomplete":{"value":{"jobComplete":false,"queryId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/grants":{"post":{"summary":"Grant permissions on a workbook to users or teams","description":"You can use this endpoint to grant specific document permissions on a specific workbook to users or teams.\n\n   ### Usage notes\n\n   - Ensure the **workbookId** in the path is valid and that the user has rights to modify its permissions. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n   - Do not set both **memberId** and **teamId** in the same **grantee** object. Instead, choose one based on the target of the grant.\n\n     - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n     - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n   - Grant permissions on a specific version tag of a workbook by specifying the **tagId**. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.\n\n   ### Usage scenarios\n\n   - **Team collaboration**: Granting edit permissions to a team for collaborative work on a project.\n   - **External consultant**: Providing view access to an external consultant.\n\n   ### Best practices\n\n   - Validate user and team IDs before submitting them in a request to avoid errors.\n   - Use the **tagId** to help manage and revoke grants systematically as project requirements change.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"createWorkbookGrant","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","items":{"allOf":[{"type":"object","required":["grantee","permission"],"properties":{"grantee":{"oneOf":[{"type":"object","required":["memberId"],"properties":{"memberId":{"type":"string"}},"description":"The UUID of the member receiving the grant","title":"Member"},{"type":"object","required":["teamId"],"properties":{"teamId":{"type":"string"}},"description":"The UUID of the team receiving the grant","title":"Team"}]},"permission":{"type":"string","enum":["view","explore","edit"],"description":"Permission to grant for access to the workbook.","title":"WorkbookPermission"}}},{"type":"object","properties":{"tagId":{"type":"string"}}}]}}},"title":"Workbook grant creation request"}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/grants/{grantId}":{"delete":{"summary":"Delete a workbook grant","description":"This endpoint deletes a specific grant from a workbook. Deleting a grant revokes the permissions associated with it, ensuring that the specified users or teams no longer have the access rights previously granted.\n\n  ### Usage notes\n  - **workbookId:** The identifier of the workbook from which the grant is to be deleted. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - **grantId:** The identifier of the grant that needs to be removed. Retrieve the **grantId** by calling the [/v2/grants](https://help.sigmacomputing.com/reference/list-grants) endpoint with the `workbookId` as the `inodeId`.\n\n  ### Usage scenarios\n  - **Access revocation:** Administrators can use this endpoint to manage and revoke access as team roles or project needs evolve.\n  - **Security compliance:** Ensures that access to sensitive data within workbooks is tightly controlled and can be promptly adjusted in response to security policy changes or personnel updates.\n\n  ### Best practices\n  - Always confirm the identities associated with both the workbook and grant before proceeding with deletion to avoid accidental revocations.\n  - Log and audit all grant deletions to maintain records for security audits and compliance tracking.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"grantId","schema":{"type":"string","description":"Unique identifier of the grant.","title":"Grant ID"},"in":"path","required":true}],"operationId":"deleteWorkbookGrant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/lineage":{"get":{"summary":"List lineage for a workbook","description":"This endpoint lists the elements, data sources, and upstream lineage for those data sources in a workbook, providing a detailed view of how data is interconnected within a workbook.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n  ### Usage scenarios\n  - **Data governance:** Allows data managers to track how information is used and propagated through different workbook elements.\n  - **Debugging and optimization:** Helps with identifying and resolving issues in data processing or workbook structure.\n  - **Data source management**: Identify the dependencies of data sources in use in a specific workbook.\n\n  ### Best practices\n  - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams.\n  - Use this endpoint to regularly audit workbook structures, ensuring that all data connections and transformations are correct and optimized.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listLineageTree","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["sourceIds","elementId","dataSourceIds"],"properties":{"sourceIds":{"type":["array","null"],"items":{"type":"string"},"description":"List of direct sources for the element. Either element IDs or data source IDs."},"elementId":{"type":"string","description":"Unique identifier of the element"},"dataSourceIds":{"type":["array","null"],"items":{"type":"string"},"description":"List of root sources for the element as data source IDs."}}}],"description":"","title":"Element details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["dataModelId"],"properties":{"dataModelId":{"type":"string"}}}],"description":"","title":"Source data model details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["inodeId"],"properties":{"inodeId":{"type":"string"}}}],"description":"","title":"Source table or dataset (deprecated) details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["definition"],"properties":{"definition":{"type":"string","description":"","title":"Custom SQL definition"}}}],"description":"","title":"Source custom SQL details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["csvId"],"properties":{"csvId":{"type":"string","description":"Unique identifier of the uploaded CSV file","title":"CSV ID"}}}],"description":"","title":"Source CSV upload details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["semanticViewId","semanticViewTable"],"properties":{"semanticViewId":{"type":"string","description":"Unique identifier of the semantic view","title":"Semantic view ID"},"semanticViewTable":{"type":"string","description":"Name of the table within the semantic view","title":"Semantic view table"}}}],"description":"","title":"Source semantic view details"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["sqlDocumentId"],"properties":{"sqlDocumentId":{"type":"string"}}}],"description":"","title":"Source SQL document details (deprecated)"},{"allOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["table","dataset","data-model","element","customSQL","csv-upload","semantic-view","sql-document","worksheet"]}}},{"type":"object","required":["connectionId","name"],"properties":{"connectionId":{"type":["string","null"]},"name":{"type":["string","null"]}}}]},{"type":"object","required":["worksheetId"],"properties":{"worksheetId":{"type":"string","description":"Unique identifier of the worksheet","title":"Worksheet ID"}}}],"description":"","title":"Source worksheet details (deprecated)"}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]},"examples":{"Response Example":{"value":{"entries":[{"type":"element","elementId":"5AbJJlOiPPtgpL3cCk7GqA","sourceIds":["QzcnTZrK9y8TjZs0T6OKO"],"dataSourceIds":["QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn"]},{"type":"element","elementId":"5AbJJlOiPPtgpL3cCk7GqA","sourceIds":["4ZJD7G8AR03qf2oySPwoc3"],"dataSourceIds":["QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn"]},{"type":"element","elementId":"3fqWi0z9SWwxuilnuq8w34","sourceIds":["2MLjb1f67ldr3FMNI2L6Pf","4ZJD7G8AR03qf2oySPwoc3"],"dataSourceIds":["QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn","d5a56ed4-16bf-4de3-be32-e0738f31be42"]},{"datasourceId":"QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn","connectionId":"dd76be0a-08bc-4c88-8a79-9956f933e701","type":"data-model","dataModelId":"d5a56ed4-16bf-4de3-be32-e0738f31be42"},{"datasourceId":"d5a56ed4-16bf-4de3-be32-e0738f31be42","connectionId":"dd76be0a-08bc-4c88-8a79-9956f933e701","type":"table","inodeId":"eef50bc2-16c5-44ee-a913-9ae9d95e5295","inodeName":"DOCKS"}],"nextPage":null}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/lineage/elements/{elementId}":{"get":{"summary":"List lineage of a workbook element","description":"This endpoint retrieves the lineage and dependencies of a specific workbook element. It provides a detailed view of how data is interconnected within a workbook, which can be critical for understanding data sources and dependencies.\n\n  ### Usage notes\n  - **workbookId:** The UUID of the workbook containing the element. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - **elementId:** The UUID of the element within the workbook whose lineage is being queried. Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.\n  - The element that you request must be a data element, such as a table, pivot table, or visualization. Requesting a UI or control element returns an error.\n\n  ### Usage scenarios\n  - **Data governance:** Allows data managers to track how information is used and propagated through different workbook elements.\n  - **Debugging and optimization:** Helps in identifying and resolving issues in data processing or in the structure of workbook setups.\n  - **Data source management**: Identify the data sources in use in a specific workbook.\n\n  ### Best practices\n  - Use this endpoint to regularly audit workbook structures, ensuring that all data connections and transformations are correct and optimized.\n  - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"elementId","schema":{"type":"string","description":"Unique identifier of the element"},"in":"path","required":true}],"operationId":"listLineage","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["dependencies","edges"],"properties":{"dependencies":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["nodeId","type"],"properties":{"nodeId":{"type":"string"},"type":{"type":"string"}},"description":"","title":"Element details"},{"allOf":[{"type":"object","required":["nodeId","type"],"properties":{"nodeId":{"type":"string"},"type":{"type":"string"}}},{"type":"object","required":["name","elementId"],"properties":{"name":{"type":"string"},"elementId":{"type":"string"}}}],"description":"","title":"Sheet details"},{"allOf":[{"type":"object","required":["nodeId","type"],"properties":{"nodeId":{"type":"string"},"type":{"type":"string"}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}],"description":"","title":"Data source details"},{"allOf":[{"type":"object","required":["nodeId","type"],"properties":{"nodeId":{"type":"string"},"type":{"type":"string"}}},{"type":"object","required":["name","semanticViewTable"],"properties":{"name":{"type":"string"},"semanticViewTable":{"type":"string"}}}],"description":"","title":"Semantic view details"}],"type":"object"}},"edges":{"type":"array","items":{"type":"object","required":["source","target","type"],"properties":{"source":{"type":"string"},"target":{"type":"string"},"type":{"type":"string","enum":["lookup","source","dependency"]}}}}}},"examples":{"Response Example":{"value":{"dependencies":{"Ttd4meevWGks3ZYdVWt8X":{"nodeId":"Ttd4meevWGks3ZYdVWt8X","type":"sheet","name":"Sum of Dock Count by City","elementId":"5AbJJlOiPPtgpL3cCk7GqA"},"4ZJD7G8AR03qf2oySPwoc3":{"nodeId":"4ZJD7G8AR03qf2oySPwoc3","type":"sheet","name":"Train Stations","elementId":"3fqWi0z9SWwxuilnuq8w34"},"2MLjb1f67ldr3FMNI2L6Pf":{"nodeId":"2MLjb1f67ldr3FMNI2L6Pf","type":"table","name":"STATIONS"}},"edges":[{"source":"4ZJD7G8AR03qf2oySPwoc3","target":"Ttd4meevWGks3ZYdVWt8X","type":"source"},{"source":"2MLjb1f67ldr3FMNI2L6Pf","target":"4ZJD7G8AR03qf2oySPwoc3","type":"source"}]}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/materialization-schedules":{"get":{"summary":"List materialization schedules for a workbook","description":"\n  **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request.\n\n   This endpoint retrieves a list of all materialization schedules associated with a workbook. Each schedule details when and how often specific workbook elements are automatically materialized to optimize performance and data freshness.\n   ### Usage notes\n   - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n   - To retrieve additional pages of results, use the response of the `nextPage` parameter as the `page` query parameter in the following request.\n\n   ### Usage scenarios\n   - **Monitoring and management:** Administrators can monitor and manage the schedules for materialization to ensure optimal system performance.\n   - **Audit and review:** Periodic reviews of materialization schedules can help in assessing the efficiency of data processes and making necessary adjustments.\n\n   ### Best practices\n   - Regularly review materialization schedules to align them with current data usage patterns and business needs.\n   - Use pagination to manage large sets of data and improve response times of API calls.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listMaterializationSchedules","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["sheetId","elementId","elementName","schedule","configuredAt","paused"],"properties":{"sheetId":{"type":"string","description":"Identifier of the materialization schedule for the element","title":"Sheet ID"},"elementId":{"type":"string","description":"Identifier of the element being materialized","title":"Element ID"},"elementName":{"type":"string"},"schedule":{"type":["object","null"],"properties":{"cronSpec":{"type":"string","description":"Cron expression to use for the schedule"},"timezone":{"type":"string","description":"Timezone code, for example, PST"}}},"configuredAt":{"type":"string","format":"date-time"},"paused":{"type":"boolean"}}}}},"description":"","title":"Single Page"},{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["sheetId","elementId","elementName","schedule","configuredAt","paused"],"properties":{"sheetId":{"type":"string","description":"Identifier of the materialization schedule for the element","title":"Sheet ID"},"elementId":{"type":"string","description":"Identifier of the element being materialized","title":"Element ID"},"elementName":{"type":"string"},"schedule":{"type":["object","null"],"properties":{"cronSpec":{"type":"string","description":"Cron expression to use for the schedule"},"timezone":{"type":"string","description":"Timezone code, for example, PST"}}},"configuredAt":{"type":"string","format":"date-time"},"paused":{"type":"boolean"}}}},"nextPage":{"type":["string","null"]}},"description":"","title":"Paginated Response"}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/materializations":{"post":{"summary":"Run a scheduled materialization for a workbook element","description":"This endpoint runs a scheduled materialization for an element in a workbook. Materialization processes the data of the specified element, allowing the data to be stored or cached for optimized access and performance.\n\n  For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n  ### Usage notes\n  - The materialization schedule for the specified element must be created beforehand.\n  - Retrieve the **sheetId** by calling the [/v2/workbooks/{workbookId}/materialization-schedules](https://help.sigmacomputing.com/reference/list-materialization-schedules) endpoint.\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n  ### Usage scenarios\n  - **Performance optimization:** Use this endpoint to improve response times for frequently accessed workbook elements.\n  - **Data refresh:** Allows users to manually (programmatically) refresh the data of specific workbook elements to ensure that the latest data is available for analysis and reporting.\n\n  ### Best practices\n  - Prioritize materialization for elements that are heavily used or form critical components of business reports.\n  - Monitor the performance impacts of materialization and adjust strategies as necessary to optimize resource usage and response times.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"materializeWorkbookElement","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["sheetId"],"properties":{"sheetId":{"type":"string","description":"Identifier for the materialization schedule of this element.","title":"Sheet ID"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["materializationId"],"properties":{"materializationId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/materializations/{materializationId}":{"get":{"summary":"Get a materialization job","description":"This endpoint retrieves details of a specific materialization job associated with a workbook by materializationId. It provides comprehensive information including status, start and completion times, which helps for monitoring and troubleshooting materialization.\n\n### Usage notes\n- Retrieve the **materializationId** by calling the [/v2/workbooks/{workbookId}/materializations](https://help.sigmacomputing.com/reference/materialize-workbook-element) endpoint.\n\n### Usage scenarios\n- **Job Monitoring:** Enables administrators to track the progress and status of materialization jobs, aiding in operational oversight.\n- **Troubleshooting:** Provides detailed information needed to diagnose and resolve issues in materialization processes.\n\n### Best practices\n- Monitor materialization jobs regularly to detect and resolve issues promptly.\n- Use the detailed information provided by this endpoint to optimize materialization settings and performance.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"materializationId","schema":{"type":"string","description":"Unique identifier of the materialization job","title":"Materialization ID"},"in":"path","required":true}],"operationId":"getWorkbookMaterialization","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["materializationId","status"],"properties":{"materializationId":{"type":"string"},"status":{"type":"string"}}},{"type":"object","properties":{"startedAt":{"type":"string","format":"date-time"},"readyAt":{"type":"string","format":"date-time"},"expiredAt":{"type":"string","format":"date-time"},"error":{"type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/pages":{"get":{"summary":"List workbook pages for a workbook","description":"This endpoint retrieves a list of all pages contained within a specified workbook. It is useful for applications needing to display an overview or navigate through different pages of a workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- To retrieve pages from version-tagged workbooks, pass the `tag` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `tags.name` included in the response for a given workbook.\n- To retrieve pages from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoints.\n\n### Usage scenarios\n- **Navigation:** Helps users and applications navigate through different pages of a workbook efficiently.\n- **Content Discovery:** Allows users to quickly view and access the variety of pages contained within a workbook.\n\n### Best practices\n- Always name pages to make it easy for users to navigate.\n- Utilize pagination to manage and streamline the retrieval of large numbers of pages.\n- Ensure that users or systems querying this endpoint have appropriate permissions to access the workbook's content.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"tag","schema":{"type":"string"},"in":"query"},{"name":"bookmarkId","schema":{"type":"string","description":"Unique identifier of the bookmark.","title":"Bookmark ID"},"in":"query"}],"operationId":"listWorkbookPages","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["pageId"],"properties":{"pageId":{"type":"string","description":"Unique identifier of the workbook page."}}},{"type":"object","properties":{"name":{"type":"string"},"hidden":{"type":"boolean"}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/pages/{pageId}/elements":{"get":{"summary":"List elements in a workbook page","description":"This endpoint retrieves all elements from a specific page within a workbook, which lets you understand and interact with the individual components that make up the page, such as charts, tables, or controls.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint.\n- To retrieve pages from version-tagged workbooks, pass the `tag` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `tags.name` included in the response for a given workbook.\n- To retrieve pages from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoints.\n\n### Usage scenarios\n- **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation.\n- **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with.\n\n### Best practices\n- Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience.\n- Validate both the workbookId and pageId to ensure they correspond to valid, accessible resources before making API calls.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"pageId","schema":{"type":"string","description":"Unique identifier of the workbook page."},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"tag","schema":{"type":"string"},"in":"query"},{"name":"bookmarkId","schema":{"type":"string","description":"Unique identifier of the bookmark.","title":"Bookmark ID"},"in":"query"}],"operationId":"listWorkbookPageElements","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"columns":{"type":"array","items":{"type":"string"}},"vizualizationType":{"type":"string"},"error":{"type":"string"}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/queries":{"get":{"summary":"List SQL queries in a workbook","description":"This endpoint retrieves a list of all SQL queries stored within a specific workbook. It is useful for developers and analysts who need to review or audit the queries being used for data manipulation and reporting within the workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n### Usage scenarios\n- **Audit and review:** Enables administrators and data governance teams to audit and review all the queries associated with a workbook for compliance and optimization.\n- **Query optimization:** Allows users to identify and optimize potentially inefficient or slow queries to improve performance.\n\n### Best practices\n- Use pagination to manage large sets of queries efficiently, especially in workbooks with extensive data manipulation.\n- Regularly review queries as part of data governance practices to ensure they remain up to date and perform optimally.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listWorkbookQueries","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["elementId"],"properties":{"elementId":{"type":"string"}}},{"type":"object","properties":{"name":{"type":"string"},"sql":{"type":"string"},"error":{"type":"string"}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/restoreVersion":{"post":{"summary":"Restore a workbook to a previous version","description":"Restore a workbook to a previous version. Restoring publishes a new version with the same contents as the version restored and does not delete or overwrite any versions created.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve available **version** numbers by calling the [/v2/workbooks/{workbookId}/version-history](https://help.sigmacomputing.com/reference/get-version-history) endpoint.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"restoreWorkbookVersion","requestBody":{"description":"Body parameters for restoring a workbook version.","content":{"application/json":{"schema":{"type":"object","required":["version"],"properties":{"version":{"type":"number","description":"The document version to restore the workbook to.","title":"Version"}},"description":"Body parameters for restoring a workbook version."}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["workbookId","workbookUrlId","name","url","path","latestVersion","ownerId"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"workbookUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number","description":"The most recently published document version of the workbook."},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","name","sourceWorkbookVersion","taggedWorkbookId","workbookTaggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"name":{"type":"string"},"sourceWorkbookVersion":{"type":"number"},"taggedWorkbookId":{"type":"string","description":"Unique identifier of the tagged workbook.","title":"Workbook ID"},"workbookTaggedAt":{"type":"string","format":"date-time"}}}},"description":{"type":"string"},"taggedSourceUrlId":{"type":"string","description":"For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/saveTemplate":{"post":{"summary":"Save a template from a workbook","description":"Create a workbook template from an existing workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- The template owner defaults to the user associated with the API credentials. You can specify an owner in the request body with the `ownerId`. Retrieve the user ID to use as the ownerID by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint and using the `memberId` included in the response.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"saveTemplateFromWorkbook","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the template to create.","title":"Template name"},"ownerId":{"type":"string"},"tag":{"type":"string"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["templateId"],"properties":{"templateId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/schedules":{"get":{"summary":"List scheduled workbook exports","description":"\n  **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request.\n\n  This endpoint retrieves a list of all scheduled exports for a specified workbook. These schedules represent planned events that can trigger exports based on various conditions and timings.\n  ### Usage Notes\n  - The **workbookId** in the path parameter identifies the workbook whose scheduled exports are to be listed. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Use pagination query parameters to manage the volume of data returned by this endpoint.\n\n  ### Usage Scenarios\n  - **Schedule Overview:** Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a workbook.\n  - **Audit and Compliance:** This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies.\n\n  ### Best Practices\n  - Implement client-side handling to manage paginated data effectively, especially in cases where a workbook has a large number of scheduled exports.\n  - Regularly audit schedules to keep them up-to-date and aligned with the current needs and workflows.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listWorkbookSchedules","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"allOf":[{"type":"object","required":["scheduledNotificationId","workbookId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["EXCEL"]}}},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}}},{"type":"object","properties":{"pixelWidth":{"type":["number","null"]},"pixelHeight":{"type":["number","null"]}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"chartId":{"type":"string"},"workbookExportSource":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["element"]},"elementId":{"type":"string"}},"description":"Export one element","title":"One element"},{"type":"object","required":["type","pageId"],"properties":{"type":{"type":"string","enum":["page"]},"pageId":{"type":"string"}},"description":"Export one page","title":"One page"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["element"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple elements","title":"Multiple elements"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["page"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple pages","title":"Multiple pages"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"Export all pages and elements in a workbook","title":"Entire workbook"}]}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"dashboardSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"workbookVariant":{"type":"object","properties":{"tagId":{"type":"string"},"exploreKey":{"type":"string"},"bookmarkId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}},"formatting":{"type":["object","null"],"properties":{"pivotHeaderStyle":{"type":["string","null"],"enum":["merged","repeated"]}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"description":"","title":"Single Page"},{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["scheduledNotificationId","workbookId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["EXCEL"]}}},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}}},{"type":"object","properties":{"pixelWidth":{"type":["number","null"]},"pixelHeight":{"type":["number","null"]}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"chartId":{"type":"string"},"workbookExportSource":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["element"]},"elementId":{"type":"string"}},"description":"Export one element","title":"One element"},{"type":"object","required":["type","pageId"],"properties":{"type":{"type":"string","enum":["page"]},"pageId":{"type":"string"}},"description":"Export one page","title":"One page"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["element"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple elements","title":"Multiple elements"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["page"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple pages","title":"Multiple pages"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"Export all pages and elements in a workbook","title":"Entire workbook"}]}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"dashboardSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"workbookVariant":{"type":"object","properties":{"tagId":{"type":"string"},"exploreKey":{"type":"string"},"bookmarkId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}},"formatting":{"type":["object","null"],"properties":{"pivotHeaderStyle":{"type":["string","null"],"enum":["merged","repeated"]}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}},"nextPage":{"type":["string","null"]}},"description":"","title":"Paginated Response"}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"post":{"summary":"Add workbook schedule","description":"Add a schedule to a workbook to export data from the workbook on a periodic basis.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Retrieve relevant IDs based on the export contents and destination:\n\n    - To export to one or more Sigma users, retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n    - To export to one or more Sigma teams, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n  - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint.\n  - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.\n    ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"postWorkbookSchedule","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["target","schedule"],"properties":{"target":{"type":"array","items":{"type":"object","properties":{"teamId":{"type":"string","description":"Unique identifier of the team to export to"},"email":{"type":"string","description":"Email address to export to"},"ccEmail":{"type":"string","description":"Email address to add as a Cc recipient"},"bccEmail":{"type":"string","description":"Email address to add as a Bcc recipient"},"ccTeamId":{"type":"string","description":"Unique identifier of the team to add as a Cc recipient"},"bccTeamId":{"type":"string","description":"Unique identifier of the team to add as a Bcc recipient"},"slackConversationId":{"type":"string","description":"Slack channel ID or member ID to export to"},"googleSpreadsheetUrl":{"type":"string","description":"URL of the Google Sheet to export to"},"googleDriveFolderUrl":{"type":"string","description":"URL of the Google Drive folder to export to"},"webhookUrl":{"type":"string","description":"URL of the webhook endpoint to export to"}}},"description":"One or more targets to send the workbook to."},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}},"description":"When to send the workbook export."}}},{"type":"object","properties":{"configV2":{"allOf":[{"type":"object","required":["title","messageBody","exportAttachments"],"properties":{"title":{"type":"string","description":"Title of the message"},"messageBody":{"type":"string","description":"Body of the message"},"exportAttachments":{"type":"array","items":{"type":"object","required":["formatOptions","workbookExportSource"],"properties":{"formatOptions":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}}],"description":"CSV export format options","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}}],"description":"JSONL export format options","title":"JSONL"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}}],"description":"JSON export format options","title":"JSON"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["XLSX"]}}}],"description":"XLSX export format options","title":"XLSX"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]}}}],"description":"PDF export format options","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}},"description":"PNG export format options","title":"PNG"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}},"description":"No export format options","title":"Google Sheets"}],"description":"Export format options","title":"Export format options"},"workbookExportSource":{"oneOf":[{"type":"object","required":["type","elementIds"],"properties":{"type":{"type":"string","enum":["element"]},"elementIds":{"type":"array","items":{"type":"string"},"description":"Array of element identifiers to export","title":"Element IDs"}},"description":"Export multiple elements","title":"Multiple elements export"},{"type":"object","required":["type","pageIds"],"properties":{"type":{"type":"string","enum":["page"]},"pageIds":{"type":"array","items":{"type":"string"},"description":"Array of page identifiers to export","title":"Page IDs"}},"description":"Export multiple pages","title":"Multiple pages export"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"Export all content","title":"Entire workbook export"}],"description":"Workbook export source options","title":"Workbook export source"}},"description":"Export attachment","title":"Export attachment"},"description":"Attachments to include in the export"}}},{"type":"object","properties":{"exportName":{"type":"string","description":"Name of the scheduled export","title":"Export name"},"includeLink":{"type":"boolean","description":"Include a link to the exported workbook","title":"Include link"},"runAsRecipient":{"type":"boolean","description":"Run the export queries as the recipient","title":"Run as recipient"},"attachmentSettings":{"type":"object","properties":{"mergeAttachments":{"type":"boolean","description":"Combines multiple PDF or XLSX attachments into a single file","title":"Merge attachments"},"zipAttachments":{"type":"boolean","description":"Send attachments as a .zip file","title":"Zip attachments"}},"description":"Export attachment settings","title":"Export attachment settings"},"workbookVariant":{"type":"object","properties":{"tagId":{"type":"string","description":"Version tag to export","title":"Version tag ID"},"bookmarkId":{"type":"string","description":"Bookmark to export","title":"Bookmark ID"}},"description":"Workbook variant","title":"Workbook variant"},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}},"description":"Always send the export","title":"Always"},{"type":"object","required":["type","condition"],"properties":{"type":{"type":"string","enum":["workbook"]},"condition":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isEmpty"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"}},"description":"If there's no data","title":"Element is empty"},{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"}},"description":"If there's data","title":"Element is not empty"},{"allOf":[{"type":"object","required":["type","elementId","columnId","op","mode"],"properties":{"type":{"type":"string","enum":["column"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"},"columnId":{"type":"string","description":"ID of the column","title":"Column ID"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNull","IsNotNull","Contains","StartsWith","EndsWith"],"description":"Operator","title":"Operator"},"mode":{"type":"string","enum":["any","all"],"description":"Kind of condition evaluation","title":"Condition check"}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"description":"Boolean value","title":"Boolean value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["integer"]},"value":{"type":"string"}},"description":"Integer value","title":"Integer value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"}],"description":"Column value","title":"Column value"}}}],"description":"If a condition is met","title":"Column meets condition"}]}},"description":"Send the export based on a condition","title":"Workbook condition"}],"description":"Export condition options","title":"Export condition options"},"workbookSettings":{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"description":"Boolean value","title":"Boolean value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"description":"Number value","title":"Number value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"}},"description":"Date value","title":"Date value"}],"description":"Scalar value","title":"Scalar value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"allOf":[{"type":"object","required":["true","false"],"properties":{"true":{"type":"boolean"},"false":{"type":"boolean"}}},{"type":"object","properties":{"null":{"type":"boolean"}}}]}},"description":"Boolean list value","title":"Boolean list value"},{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"description":"Number value","title":"Number value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}},"description":"Null number value","title":"Null number value"}]}}},"description":"Number list value","title":"Number list value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}},"description":"Null text value","title":"Null text value"}]}}},"description":"Text list value","title":"Text list value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}]}}},"description":"Date list value","title":"Date list value"}],"description":"List value","title":"List value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["hierarchical-list"]},"value":{"type":"array","items":{"type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"}},"description":"Array of hierarchy paths. Each path is an array of segments, from the highest selected level of the hierarchy down to the lowest selected level of the hierarchy. Each segment is a `{type: \"text\", value: string}` object. For example, a Region/State/City hierarchy control with Oakland selected would be represented as `[[{\"type\":\"text\",\"value\":\"West\"}, {\"type\":\"text\",\"value\":\"California\"}, {\"type\":\"text\",\"value\":\"Oakland\"}]]`","title":"Hierarchy paths"}},"description":"Hierarchical list value","title":"Hierarchical list value"},{"type":"object","required":["type","min","max"],"properties":{"type":{"type":"string","enum":["date-range"]},"min":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"},"max":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"}},"description":"Date range value","title":"Date range value"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"min":{"type":"number","description":"Minimum value of the range","title":"Minimum value"},"max":{"type":"number","description":"Maximum value of the range","title":"Maximum value"}}}],"description":"Number range value","title":"Number range value"},{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}},"description":"Null number value","title":"Null number value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}},"description":"Null text value","title":"Null text value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}},"description":"Null boolean value","title":"Null boolean value"}],"description":"Null value","title":"Null value"}],"description":"Variable value","title":"Variable value","type":"object"},"description":"This object maps control IDs to the values that they should have when exporting the workbook.","title":"Control values"}},"description":"Workbook settings","title":"Workbook settings"},"formatting":{"type":"object","properties":{"pivotHeaderStyle":{"type":"string","enum":["merged","repeated"],"description":"Style of pivot table headers","title":"Pivot header style"},"includeMetadata":{"type":"boolean","description":"Whether to include metadata in XLSX exports","title":"Include metadata"}},"description":"Export formatting options","title":"Export formatting options"}}}],"description":"Configuration settings for the export schedule."},"config":{"allOf":[{"type":"object","required":["formatOptions","title","messageBody"],"properties":{"formatOptions":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}}],"description":"CSV export format options","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}}],"description":"JSONL export format options","title":"JSONL"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}}],"description":"JSON export format options","title":"JSON"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["XLSX"]}}}],"description":"XLSX export format options","title":"XLSX"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]}}}],"description":"PDF export format options","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}},"description":"PNG export format options","title":"PNG"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}},"description":"No export format options","title":"Google Sheets"}],"description":"Export format options"},"title":{"type":"string","description":"Title of the message"},"messageBody":{"type":"string","description":"Body of the message"}}},{"type":"object","properties":{"includeLink":{"type":"boolean","description":"Whether to include a link to the exported folder or document in the body of the message"},"runAsRecipient":{"type":"boolean","description":"Whether to run the export as if it were being run by the recipient"},"rowLimit":{"type":"number","description":"Maximum number of rows to export"},"chartId":{"type":"string","description":"Identifier of the chart to export"},"parameters":{"type":"object","additionalProperties":{"type":"string"},"description":"Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value.\n\n**Syntax**\n{ control-id: control-value }\n\nThe control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.\n\nValues can take multiple forms, depending on the data type of the control:\n\n**Boolean**\n\n- Single value: \"true\" | \"false\" | \":null\"\n- List of Boolean: \"true,false,:null\" (No space after the comma.)\n\n**Number**\n\n- Single value: \"10.54\", \":null\"\n- List of values: \"10.54,23.45,:null\" (No space after the comma.)\n- Range of numbers: \"min:10.54,max:23.45\" (No space after the comma or colon.)\n\n**Text**\n\n- Single value: \"some-text\" | \":null\" | \":empty\"\n- List of values: \"some-text,more-text,:null,:empty\" (No space after the comma.)\n\n**Date**\n\nAll dates use UTC time zones.\n\n- Fixed date using ISO-6801 format: \"2022-01-01T01:01:59\" | \":null\"\n    - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):\n        - %Y-%m-%d\n        - %Y-%m-%dT%H:%M\n        - %Y-%m-%dT%H:%M:%S\n- List of fixed dates: \"2022-01-01T01:01:59,2022-02-02T02:02:59,:null\"\n- Relative date: \"prior-day-3\" | \"next-day-3\"\n    - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]\n- Date range: \"min:2022-01-01T01:01:59,max:next-day-3\" (No spaces after the comma or colon.)\n    - Leave max blank for \"on or after\" and min blank for \"on or before\", for example:\n        - \"Date-Range\": \"min:2020-04-01,max:\"\n        - \"Date-Range\": \"min:,max:next-day-3\"\n\n**Notes**\n\n- \":null\" is a special value that denotes the null primitive value.\n- \":empty\" is a special value that denotes the empty string \"\".\n\nUse [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.\n\nFor example:\n\"New York, NY,Boston, MA\" can be encoded as:\n\n\"New%20York%2C%20NY,Boston%2C%20MA\""}}}],"description":"**[Deprecated]** Configuration settings for the export."},"description":{"type":["string","null"],"description":"Description of the scheduled export"},"ownerId":{"type":"string","description":"ID of the user (member) to own the export."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["scheduledNotificationId","workbookId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["EXCEL"]}}},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}}},{"type":"object","properties":{"pixelWidth":{"type":["number","null"]},"pixelHeight":{"type":["number","null"]}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"chartId":{"type":"string"},"workbookExportSource":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["element"]},"elementId":{"type":"string"}},"description":"Export one element","title":"One element"},{"type":"object","required":["type","pageId"],"properties":{"type":{"type":"string","enum":["page"]},"pageId":{"type":"string"}},"description":"Export one page","title":"One page"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["element"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple elements","title":"Multiple elements"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["page"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple pages","title":"Multiple pages"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"Export all pages and elements in a workbook","title":"Entire workbook"}]}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"dashboardSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"workbookVariant":{"type":"object","properties":{"tagId":{"type":"string"},"exploreKey":{"type":"string"},"bookmarkId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}},"formatting":{"type":["object","null"],"properties":{"pivotHeaderStyle":{"type":["string","null"],"enum":["merged","repeated"]}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/schedules/{scheduleId}":{"patch":{"summary":"Update a workbook schedule","description":"Update a schedule of a workbook to export data from the workbook on a periodic basis.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Retrieve the **scheduleId** by calling the [/v2/workbooks/{workbookId}/schedules](https://help.sigmacomputing.com/reference/list-workbook-schedules) endpoint.\n  - To add or update a team recipient, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n   ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"scheduleId","schema":{"type":"string","description":"Unique identifier of the schedule.","title":"Schedule ID"},"in":"path","required":true}],"operationId":"updateWorkbookSchedule","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"target":{"type":"array","items":{"type":"object","properties":{"teamId":{"type":"string","description":"Unique identifier of the team to export to"},"email":{"type":"string","description":"Email address to export to"},"ccEmail":{"type":"string","description":"Email address to add as a Cc recipient"},"bccEmail":{"type":"string","description":"Email address to add as a Bcc recipient"},"ccTeamId":{"type":"string","description":"Unique identifier of the team to add as a Cc recipient"},"bccTeamId":{"type":"string","description":"Unique identifier of the team to add as a Bcc recipient"},"slackConversationId":{"type":"string","description":"Slack channel ID or member ID to export to"},"googleSpreadsheetUrl":{"type":"string","description":"URL of the Google Sheet to export to"},"googleDriveFolderUrl":{"type":"string","description":"URL of the Google Drive folder to export to"},"webhookUrl":{"type":"string","description":"URL of the webhook endpoint to export to"}}},"description":"One or more targets to send the workbook to."},"schedule":{"type":"object","properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}},"description":"When to send the workbook export."},"configV2":{"type":"object","properties":{"title":{"type":"string","description":"Title of the message"},"messageBody":{"type":"string","description":"Body of the message"},"exportAttachments":{"type":"array","items":{"type":"object","required":["formatOptions","workbookExportSource"],"properties":{"formatOptions":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}}],"description":"CSV export format options","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}}],"description":"JSONL export format options","title":"JSONL"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}}],"description":"JSON export format options","title":"JSON"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["XLSX"]}}}],"description":"XLSX export format options","title":"XLSX"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]}}}],"description":"PDF export format options","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}},"description":"PNG export format options","title":"PNG"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}},"description":"No export format options","title":"Google Sheets"}],"description":"Export format options","title":"Export format options"},"workbookExportSource":{"oneOf":[{"type":"object","required":["type","elementIds"],"properties":{"type":{"type":"string","enum":["element"]},"elementIds":{"type":"array","items":{"type":"string"},"description":"Array of element identifiers to export","title":"Element IDs"}},"description":"Export multiple elements","title":"Multiple elements export"},{"type":"object","required":["type","pageIds"],"properties":{"type":{"type":"string","enum":["page"]},"pageIds":{"type":"array","items":{"type":"string"},"description":"Array of page identifiers to export","title":"Page IDs"}},"description":"Export multiple pages","title":"Multiple pages export"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"Export all content","title":"Entire workbook export"}],"description":"Workbook export source options","title":"Workbook export source"}},"description":"Export attachment","title":"Export attachment"},"description":"Attachments to include in the export"},"exportName":{"type":"string","description":"Name of the scheduled export","title":"Export name"},"includeLink":{"type":"boolean","description":"Include a link to the exported workbook","title":"Include link"},"runAsRecipient":{"type":"boolean","description":"Run the export queries as the recipient","title":"Run as recipient"},"attachmentSettings":{"type":"object","properties":{"mergeAttachments":{"type":"boolean","description":"Combines multiple PDF or XLSX attachments into a single file","title":"Merge attachments"},"zipAttachments":{"type":"boolean","description":"Send attachments as a .zip file","title":"Zip attachments"}},"description":"Export attachment settings","title":"Export attachment settings"},"workbookVariant":{"type":"object","properties":{"tagId":{"type":"string","description":"Version tag to export","title":"Version tag ID"},"bookmarkId":{"type":"string","description":"Bookmark to export","title":"Bookmark ID"}},"description":"Workbook variant","title":"Workbook variant"},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}},"description":"Always send the export","title":"Always"},{"type":"object","required":["type","condition"],"properties":{"type":{"type":"string","enum":["workbook"]},"condition":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isEmpty"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"}},"description":"If there's no data","title":"Element is empty"},{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"}},"description":"If there's data","title":"Element is not empty"},{"allOf":[{"type":"object","required":["type","elementId","columnId","op","mode"],"properties":{"type":{"type":"string","enum":["column"],"description":"Type of condition","title":"Condition type"},"elementId":{"type":"string","description":"ID of the element","title":"Element ID"},"columnId":{"type":"string","description":"ID of the column","title":"Column ID"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNull","IsNotNull","Contains","StartsWith","EndsWith"],"description":"Operator","title":"Operator"},"mode":{"type":"string","enum":["any","all"],"description":"Kind of condition evaluation","title":"Condition check"}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"description":"Boolean value","title":"Boolean value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["integer"]},"value":{"type":"string"}},"description":"Integer value","title":"Integer value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"}],"description":"Column value","title":"Column value"}}}],"description":"If a condition is met","title":"Column meets condition"}]}},"description":"Send the export based on a condition","title":"Workbook condition"}],"description":"Export condition options","title":"Export condition options"},"workbookSettings":{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"type":"boolean"}},"description":"Boolean value","title":"Boolean value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"description":"Number value","title":"Number value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"}},"description":"Date value","title":"Date value"}],"description":"Scalar value","title":"Scalar value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"allOf":[{"type":"object","required":["true","false"],"properties":{"true":{"type":"boolean"},"false":{"type":"boolean"}}},{"type":"object","properties":{"null":{"type":"boolean"}}}]}},"description":"Boolean list value","title":"Boolean list value"},{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"type":"number"}},"description":"Number value","title":"Number value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}},"description":"Null number value","title":"Null number value"}]}}},"description":"Number list value","title":"Number list value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}},"description":"Null text value","title":"Null text value"}]}}},"description":"Text list value","title":"Text list value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}]}}},"description":"Date list value","title":"Date list value"}],"description":"List value","title":"List value"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["hierarchical-list"]},"value":{"type":"array","items":{"type":"array","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"type":"string"}},"description":"Text value","title":"Text value"}},"description":"Array of hierarchy paths. Each path is an array of segments, from the highest selected level of the hierarchy down to the lowest selected level of the hierarchy. Each segment is a `{type: \"text\", value: string}` object. For example, a Region/State/City hierarchy control with Oakland selected would be represented as `[[{\"type\":\"text\",\"value\":\"West\"}, {\"type\":\"text\",\"value\":\"California\"}, {\"type\":\"text\",\"value\":\"Oakland\"}]]`","title":"Hierarchy paths"}},"description":"Hierarchical list value","title":"Hierarchical list value"},{"type":"object","required":["type","min","max"],"properties":{"type":{"type":"string","enum":["date-range"]},"min":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"},"max":{"oneOf":[{"type":"object","required":["type","date"],"properties":{"type":{"type":"string","enum":["fixed-date"]},"date":{"type":"string","description":"ISO-8601 date string","title":"ISO-8601 date string"}},"description":"Fixed date selection","title":"Fixed date selection"},{"type":"object","required":["type","unit","x"],"properties":{"type":{"type":"string","enum":["prior","next"]},"unit":{"type":"string","enum":["year","quarter","month","week","isoWeek","day","hour","minute","second"]},"x":{"type":"number"}},"description":"Relative date selection, for example \"Next 4 days\"","title":"Relative date selection"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"}],"description":"Date selection","title":"Date selection"}},"description":"Date range value","title":"Date range value"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","properties":{"min":{"type":"number","description":"Minimum value of the range","title":"Minimum value"},"max":{"type":"number","description":"Maximum value of the range","title":"Maximum value"}}}],"description":"Number range value","title":"Number range value"},{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}},"description":"Null date value","title":"Null date value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}},"description":"Null number value","title":"Null number value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}},"description":"Null text value","title":"Null text value"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}},"description":"Null boolean value","title":"Null boolean value"}],"description":"Null value","title":"Null value"}],"description":"Variable value","title":"Variable value","type":"object"},"description":"This object maps control IDs to the values that they should have when exporting the workbook.","title":"Control values"}},"description":"Workbook settings","title":"Workbook settings"},"formatting":{"type":"object","properties":{"pivotHeaderStyle":{"type":"string","enum":["merged","repeated"],"description":"Style of pivot table headers","title":"Pivot header style"},"includeMetadata":{"type":"boolean","description":"Whether to include metadata in XLSX exports","title":"Include metadata"}},"description":"Export formatting options","title":"Export formatting options"}},"description":"Configuration settings for the export schedule."},"description":{"type":["string","null"],"description":"Description of the scheduled export"},"suspensionAction":{"type":"string","enum":["pause","resume"],"description":"Action to take on the schedule. Use `pause` to pause the schedule and `resume` to resume the schedule."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["scheduledNotificationId","workbookId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["EXCEL"]}}},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}}},{"type":"object","properties":{"pixelWidth":{"type":["number","null"]},"pixelHeight":{"type":["number","null"]}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"chartId":{"type":"string"},"workbookExportSource":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["element"]},"elementId":{"type":"string"}},"description":"Export one element","title":"One element"},{"type":"object","required":["type","pageId"],"properties":{"type":{"type":"string","enum":["page"]},"pageId":{"type":"string"}},"description":"Export one page","title":"One page"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["element"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple elements","title":"Multiple elements"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["page"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple pages","title":"Multiple pages"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"Export all pages and elements in a workbook","title":"Entire workbook"}]}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"dashboardSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"workbookVariant":{"type":"object","properties":{"tagId":{"type":"string"},"exploreKey":{"type":"string"},"bookmarkId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}},"formatting":{"type":["object","null"],"properties":{"pivotHeaderStyle":{"type":["string","null"],"enum":["merged","repeated"]}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"delete":{"summary":"Delete a scheduled export for a workbook","description":"This endpoint deletes a specific scheduled export from a workbook. Deleting a schedule prevents any previously configured exports or alerts from being triggered at the scheduled times.\n\n  ### Usage notes\n  - The `workbookId` in the path is required to identify the workbook. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - The `scheduleId` in the path is required to specify which schedule to delete. Retrieve the **scheduleId** by calling the [/v2/workbooks/{workbookId}/schedules](https://help.sigmacomputing.com/reference/list-workbook-schedules) endpoint and using the `scheduledNotificationId` in the response.\n\n  ### Usage scenarios\n  - **Cleanup operations:** Use this endpoint to remove unnecessary or outdated schedules that are no longer relevant to the workbook's current use case.\n  - **Configuration updates:** When a workbook's usage patterns change, corresponding schedules might need to be deleted to align with the new setup.\n\n  ### Best practices\n  - Make sure that deleting a given schedule is in compliance with your organization's data governance and operational policies.\n  - Verify the `scheduleId` and `workbookId` before making a deletion request to prevent errors.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"scheduleId","schema":{"type":"string","description":"Unique identifier of the schedule.","title":"Schedule ID"},"in":"path","required":true}],"operationId":"deleteWorkbookSchedule","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/schema":{"get":{"summary":"Get workbook schema","description":"The Workbook Schema API is deprecated as of December 15, 2023. This endpoint is no longer compatible with workbook layouts. Workflows that use this endpoint must be replaced with the new endpoints listed below. The components in Workbook Schema API are available through individual endpoints to minimize the retrieval of unnecessary data.\n\n- [GET v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/listworkbookpages)\n- [GET v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/listworkbookpageelements)\n- [GET v2/workbooks/{workbookId}/queries](https://help.sigmacomputing.com/reference/listworkbookqueries)\n- [GET v2/workbooks/{workbookId}/elements/{elementId}/query](https://help.sigmacomputing.com/reference/getelementquery)\n    ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"includeSql","schema":{"type":"boolean"},"in":"query"},{"name":"tag","schema":{"type":"string"},"in":"query"}],"operationId":"getWorkbookSchema","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["workbookId","workbookUrlId","pages","sheets","variables","elements","sqlQueries","sqlQueryErrors"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"workbookUrlId":{"type":"string"},"pages":{"type":"object","additionalProperties":{}},"sheets":{"type":"object","additionalProperties":{}},"variables":{"type":"object","additionalProperties":{}},"elements":{"type":"object","additionalProperties":{}},"sqlQueries":{"type":"object","additionalProperties":{"type":"string"}},"sqlQueryErrors":{"type":"object","additionalProperties":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"examples":{"Response Example":{"value":{"workbookId":"88889999-aaaa-bbbb-cccc-ddddeeeeffff","workbookUrlId":"57a96EMo3GVJG73179MV2l","pages":{"page1":"[Object Page_t]"},"sheets":{"sheet1":"[Object Sheet_t]"},"variables":{"variable1":"[Object Variable_t]"},"elements":{"element1":"[Object Element_t]","element2":"[Object Element_t]"},"sqlQueries":{"element1":"SELECT customerID, sum(AMOUNT) FROM ORDERS GROUP BY customerID"},"sqlQueryErrors":{"element2":{"message":"SQL compilation error: xxx"}}}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"],"deprecated":true}},"/v2/workbooks/{workbookId}/send":{"post":{"summary":"Export a workbook","description":"Export a workbook to one or more destinations, such as an email address, a Slack channel, or cloud storage.\n\n  ### Usage notes\n\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - This endpoint is rate limited to 100 requests per minute.\n      ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"sendWorkbook","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"parameters":{"type":"object","additionalProperties":{"type":"string"}},"timeout":{"type":"number"},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"elementId":{"type":"string"}},"description":"","title":"Is Empty"},{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"elementId":{"type":"string"}},"description":"","title":"Is Not Empty"},{"allOf":[{"type":"object","required":["type","elementId","columnId","op","mode"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"elementId":{"type":"string"},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNull","IsNotNull","Contains","StartsWith","EndsWith"],"description":"Operator"},"mode":{"type":"string","enum":["any","all"],"description":"Check condition"}}},{"type":"object","properties":{"value":{"oneOf":[{"$ref":"#/components/schemas/DataTypes"},{"type":"null"}],"description":"Data value","title":"Value to check against the operator and selected condition"}}}],"description":"","title":"Specific column value in an element"}],"description":"Send based on conditions"}},"sendAsUser":{"type":"string"}}},{"type":"object","properties":{}},{"type":"object","required":["targets","config","attachments"],"properties":{"targets":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","userId"],"properties":{"type":{"type":"string","enum":["member"]},"userId":{"type":"string"}},"description":"","title":"User"},{"type":"object","required":["type","teamId"],"properties":{"type":{"type":"string","enum":["team"]},"teamId":{"type":"string"}},"description":"","title":"Team"},{"type":"object","required":["type","email"],"properties":{"type":{"type":"string","enum":["email"]},"email":{"type":"string"}},"description":"","title":"Email"},{"type":"object","required":["type","slackConversationId"],"properties":{"type":{"type":"string","enum":["slackChannel"]},"slackConversationId":{"type":"string"}},"description":"","title":"Slack channel"},{"type":"object","required":["type","googleSpreadsheetUrl"],"properties":{"type":{"type":"string","enum":["gsheet"]},"googleSpreadsheetUrl":{"type":"string"}},"description":"","title":"Google Sheets"},{"type":"object","required":["type","googleDriveFolderUrl"],"properties":{"type":{"type":"string","enum":["gdrive"]},"googleDriveFolderUrl":{"type":"string"}},"description":"","title":"Google Drive"},{"type":"object","required":["type","cloudExport"],"properties":{"type":{"type":"string","enum":["cloud-export"]},"cloudExport":{"oneOf":[{"type":"object","required":["bq"],"properties":{"bq":{"type":"object","required":["bqDestination"],"properties":{"bqDestination":{"type":"string"}}}}},{"type":"object","required":["sf"],"properties":{"sf":{"type":"object","required":["sfDestination","authorization"],"properties":{"sfDestination":{"type":"string"},"authorization":{"type":"string"}}}}},{"type":"object","required":["rs"],"properties":{"rs":{"type":"object","required":["rsDestination","authorization"],"properties":{"rsDestination":{"type":"string"},"authorization":{"type":"string"}}}}}]}},"description":"","title":"Cloud Storage"},{"type":"object","required":["type","webhookUrl"],"properties":{"type":{"type":"string","enum":["webhook"]},"webhookUrl":{"type":"string"}},"description":"","title":"Webhook"},{"type":"object","required":["type","workbookCloudExport"],"properties":{"type":{"type":"string","enum":["workbook-cloud-export"]},"workbookCloudExport":{"allOf":[{"oneOf":[{"type":"object","required":["connectionType","authorization"],"properties":{"connectionType":{"type":"string","enum":["snowflake","redshift"]},"authorization":{"type":"string"}}},{"type":"object","required":["connectionType"],"properties":{"connectionType":{"type":"string","enum":["bigQuery"]}}}]},{"type":"object","required":["uri","exportFormat","timestampedUri"],"properties":{"uri":{"type":"string"},"exportFormat":{"type":"string","enum":["csv","csv.gzip"]},"timestampedUri":{"type":["string","null"]}}}]}},"description":"","title":"Cloud Storage for a Workbook"}]}},"config":{"allOf":[{"type":"object","required":["title","messageBody"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"rowLimit":{"type":"number"}}}]},"attachments":{"type":"array","items":{"type":"object","required":["formatOptions","source"],"properties":{"formatOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["EXCEL"]}}},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}}},{"type":"object","properties":{"pixelWidth":{"type":["number","null"]},"pixelHeight":{"type":["number","null"]}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]},"source":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["element"]},"elementId":{"type":"string"}},"description":"Export one element","title":"One element"},{"type":"object","required":["type","pageId"],"properties":{"type":{"type":"string","enum":["page"]},"pageId":{"type":"string"}},"description":"Export one page","title":"One page"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["element"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple elements","title":"Multiple elements"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["page"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple pages","title":"Multiple pages"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"Export all pages and elements in a workbook","title":"Entire workbook"}]}}}}}}]},"examples":{"Example request":{"value":{"targets":[{"type":"email","email":"test@example.com"}],"config":{"title":"My report","messageBody":"My report body","includeLink":true,"runAsRecipient":true},"attachments":[{"formatOptions":{"type":"PDF"},"source":{"type":"all"}}]}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/shareCrossOrg":{"post":{"summary":"Share a workbook with another organization","description":"Share a workbook or a template with another organization. Optionally share the associated datasets, if datasets (deprecated) are used as the source.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **templateId** by calling the [v2/templates](https://help.sigmacomputing.com/reference/list-templates) endpoint.\n- Retrieve the organization slug from the URL. Ask the recipient organization for the segment of their Sigma URL following `app.sigmacomputing.com`. For example, `app.sigmacomputing.com/sigma-docs` has an organization slug of `sigma-docs`.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"The unique identifier of the workbook or template. This ID is used to fetch, update, or delete specific workbook resources.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"shareWorkbookCrossOrg","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["orgSlugs"],"properties":{"orgSlugs":{"type":"array","items":{"type":"string"},"description":"The unique identifiers of the organizations to share the workbook with.","title":"Organization slug"}}},{"type":"object","properties":{"shareDatasets":{"type":"boolean","description":"Whether to share the datasets (deprecated) associated with the workbook.","title":"Share datasets"},"copyInputTableData":{"type":"boolean","description":"Whether to copy input table data to the recipient organization.","title":"Copy input table data"},"sendEmail":{"type":"boolean","description":"Whether to send an email to admins in the recipient org.","title":"Send email"},"emailMessage":{"type":"string","description":"The message to send to the recipients, if sendEmail is true.","title":"Email message"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/sources":{"get":{"summary":"List workbook sources","description":"Get the data sources of a workbook given the workbookId. The response can be a dataset (deprecated), table, custom SQL element, or the data model document and specific elements used as a source.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"getWorkbookSources","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["type","dataModelId","elementIds"],"properties":{"type":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string"},"elementIds":{"type":"array","items":{"type":"string"}}}},{"type":"object","properties":{"versionTagId":{"type":"string"}}}],"title":"Data model source"},{"type":"object","required":["type","inodeId","url"],"properties":{"type":{"type":"string","enum":["dataset"],"description":"Dataset (deprecated)"},"inodeId":{"type":"string"},"url":{"type":"string","description":"URL to open this dataset in Sigma."}},"title":"Dataset source (deprecated)"},{"type":"object","required":["type","inodeId"],"properties":{"type":{"type":"string","enum":["table"]},"inodeId":{"type":"string"}},"title":"Table source"},{"type":"object","required":["type","connectionId","definition","customSqlId"],"properties":{"type":{"type":"string","enum":["custom-sql"]},"connectionId":{"type":"string","description":"ID of the connection where the custom SQL element is run."},"definition":{"type":"string","description":"Raw SQL definition for the custom SQL element."},"customSqlId":{"type":"string","description":"Element ID of the custom SQL."}},"title":"Custom SQL element"}]}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/spec":{"get":{"summary":"Get the code representation of a workbook (Beta)","description":"This endpoint returns a code representation of a workbook, including metadata and contents. The response can be formatted as either JSON or YAML, and contains the workbook's pages, elements, columns, sources, and more. The representation can be used to store, copy, or modify the workbook programmatically.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\nFor more information on managing workbooks programmatically, see [Manage workbooks as code](https://help.sigmacomputing.com/docs/manage-workbooks-as-code). For more information on using this endpoint, including end-to-end instructions, see [Get the code representation of a workbook](https://help.sigmacomputing.com/docs/get-the-code-representation-of-a-workbook).\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- The code representation is returned in the `document` field. The remaining top-level fields are workbook metadata maintained by Sigma, such as `name`, `folderId`, and `documentVersion`.\n- You can submit this response unchanged to the create and update endpoints. Metadata sent alongside `document` is ignored on update.\n- The response includes references to the data sources and metadata necessary to recreate the workbook. The data itself is not included in the response.\n- To create a new workbook from code, use the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint.\n- To update an existing workbook from code, use the [/v2/workbooks/{workbookId}/spec](https://help.sigmacomputing.com/reference/update-workbook-spec) endpoint.\n- The default format of the representation is YAML. To receive JSON, add the query parameter `?format=json` or the header `Accept: application/json`.\n\n### Usage scenarios\n- **Backup and restore**: Developers can use this endpoint to programmatically back up workbooks and restore them if needed.\n- **Version control**: Developers can use this endpoint to programmatically manage, update, and version control workbooks between several organizations or tenants.\n","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"documentVersion","schema":{"type":"integer"},"in":"query"},{"name":"format","schema":{"oneOf":[{"type":"string","enum":["yaml"]},{"type":"string","enum":["yml"]},{"type":"string","enum":["json"]}]},"in":"query"}],"operationId":"getWorkbookSpec","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","required":["workbookId"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"}}},{"type":"object","required":["name","url","documentVersion","latestDocumentVersion","ownerId","folderId","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"name":{"type":"string","description":"The name of the workbook."},"url":{"type":"string","description":"The full URL for the requested document version of the workbook."},"documentVersion":{"type":"number","description":"The document version of the workbook."},"latestDocumentVersion":{"type":"number","description":"The most recently published document version of the workbook."},"ownerId":{"type":"string","description":"The identifier of the user who owns the workbook."},"folderId":{"type":"string","description":"The identifier of the folder in which the workbook is located."},"createdBy":{"type":"string","description":"The identifier of the user who created the workbook."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated the workbook."},"createdAt":{"type":"string","format":"date-time","description":"When the workbook was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the workbook was last updated."}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the workbook."}}}]},{"type":"object","required":["document"],"properties":{"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the workbook."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["workbook"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages of the workbook."}}},{"type":"object","required":["elements"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/WorkbookElement"},"description":"The elements in this workbook and their definitions."}}},{"type":"object","properties":{"overlays":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the modal page."},"type":{"type":"string","enum":["modal"],"description":"Marks this page as a modal."},"name":{"type":"string","description":"The name of the modal."}}},{"type":"object","properties":{"modal":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"footer":{"type":"object","properties":{"primaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The primary footer button."},"secondaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The secondary footer button."}},"description":"The footer with primary and secondary buttons."}}}],"description":"The modal presentation options, including width, header, and footer buttons."},"singleRowContainer":{"allOf":[{"type":"object","required":["source","keyColumnId"],"properties":{"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source that supplies the displayed row."},"keyColumnId":{"type":"string","description":"The ID of the source column that identifies which row is displayed. Must be a column declared on the source."}}},{"type":"object","properties":{"keyColumnValue":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The key-column value of the row to display. Must match the key column type. Omit to pin no row."}}}],"description":"Pins the modal to one row of a source: the elements inside it show that row. Omit for an ordinary modal."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions on the modal. Each action's `trigger` must be one of `on-primary-cta-click`, `on-secondary-cta-click`, or `on-close`."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The background image for the modal. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Modal"},{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the drawer page."},"type":{"type":"string","enum":["drawer"],"description":"Marks this page as a drawer."},"name":{"type":"string","description":"The name of the drawer."}}},{"type":"object","properties":{"drawer":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"showShadow":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to display the drawer as a page overlay, dimming the page behind it when open. Either `shown` to dim the background page or `hidden` for none."}}}],"description":"The presentation of the drawer, including width, header, and page overlay."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by the drawer, on close."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"Background image for the drawer. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Drawer"},{"allOf":[{"type":"object","required":["id","type","name","popover"],"properties":{"id":{"type":"string","description":"The identifier of the popover page."},"type":{"type":"string","enum":["popover"],"description":"Marks this page as a popover."},"name":{"type":"string","description":"The name of the popover."},"popover":{"allOf":[{"type":"object","required":["triggerElementId"],"properties":{"triggerElementId":{"type":"string","description":"The identifier of the button that triggers the popover."}}},{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"Popover width breakpoint: x-small, small, medium, large, or x-large."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"padding":{"type":"string","enum":["none"],"description":"Set to 'none' to remove padding from the popover."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Gap between popover elements: 'shown' (default) or 'hidden'."}}}],"description":"Popover presentation: trigger button, width, spacing, padding, and element gap."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions fired by the popover when it closes."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Popover"}]},"description":"The modals, drawers, and popovers in this workbook and their contents."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page header."},"type":{"type":"string","enum":["header"],"description":"Identifies this panel as a page header."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the header."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["shadow"]},{"type":"string","enum":["none"]}],"description":"The border drawn below the header. One of `line`, `shadow`, or `none`. `shadow` applies only when `scroll` is `sticky`."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The header presentation, including scroll behavior, border, background, and height."}}}],"title":"PageHeader"},{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page sidebar."},"type":{"type":"string","enum":["sidebar"],"description":"Identifies this panel as a page sidebar."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the sidebar."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"width":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Sidebar width preset. One of `small` (200px), `medium` (260px), or `large` (400px). Defaults to `medium`."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["none"]}],"description":"The border style for the sidebar."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The sidebar presentation, including scroll behavior, border, and background color."}}}],"title":"PageSidebar"}]},"description":"The definitions of page headers and sidebars in this document."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}},{"type":"object","properties":{"agents":{"type":"array","items":{"allOf":[{"type":"object","required":["id","instructions"],"properties":{"id":{"type":"string","description":"The identifier of the agent."},"instructions":{"type":"string","description":"Instructions that guide the agent. Use `{{formula}}` for dynamic values, `@dataSource(\"elementId\")` for configured data sources, and `@tool(\"toolId\")` for configured tools."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the agent."},"description":{"type":"string","description":"The description of the agent."},"greeting":{"oneOf":[{"type":"object","required":["mode","message"],"properties":{"mode":{"type":"string","enum":["static"]},"message":{"type":"string","description":"The first message an agent displays when the chat opens. Not generated by the AI provider. Supports dynamic `{{formula}}` text."}},"description":"","title":"Fixed greeting"},{"type":"object","required":["mode","prompt"],"properties":{"mode":{"type":"string","enum":["generated"]},"prompt":{"type":"string","description":"The prompt the agent uses to generate the first message displayed when the chat opens. Supports dynamic `{{formula}}` text."}},"description":"","title":"Generated greeting"}],"description":"The greeting message for the agent. Set `mode` to `static` with a `message`, or `generated` with a `prompt`. Omit for the product default."},"dataSources":{"type":"array","items":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of a workbook element, such as a table or chart, the agent can read from."}},"description":"","title":"Workbook element"},"description":"The data elements or data model tables the agent can access."},"tools":{"type":"array","items":{"oneOf":[{"type":"object","required":["toolId","kind","connectorId","name"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["mcp-connector"]},"connectorId":{"type":"string","description":"The UUID of the MCP connector."},"name":{"type":"string","description":"The display name of the MCP connector."}},"description":"","title":"MCP connector"},{"allOf":[{"type":"object","required":["toolId","kind"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["warehouse-agent"]}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of when the agent should invoke this warehouse agent."}}}],"description":"","title":"Warehouse agent"},{"allOf":[{"type":"object","required":["toolId","kind","description"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["search-service"]},"description":{"type":"string","description":"A description of what this search service can retrieve, used by the agent to decide when to call it."}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}}],"description":"","title":"Search service"},{"allOf":[{"type":"object","required":["toolId","kind","name","description","steps"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["action"]},"name":{"type":"string","description":"The display name of the action tool."},"description":{"type":"string","description":"A description of what this tool does and when the agent should invoke it."},"steps":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["kind","sequenceId"],"properties":{"kind":{"type":"string","enum":["sequence"]},"sequenceId":{"type":"string","description":"The identifier of an action sequence in the workbook."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"","title":"Sequence reference"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["effect"]}}},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"An action effect to run. Effects that depend on user interaction, such as a selected row or column, are not supported.","title":"Inline effect"}]},"description":"The steps the agent runs when it invokes this action tool."}}},{"type":"object","properties":{"requiresApproval":{"type":"boolean","description":"Whether the agent must pause to get user approval before running this tool. Defaults to `false`."}}}],"description":"","title":"Action"}]},"description":"The tools the agent can invoke to take action or enrich insights."}}}]},"description":"The agents defined in the workbook. Reference one from a chat element using `agentId`."}}},{"type":"object","properties":{"automatedActions":{"type":"array","items":{"allOf":[{"type":"object","required":["effects","id","schedule","trigger"],"properties":{"effects":{"type":"array","items":{"allOf":[{"type":"object","required":["agentId","effect","prompt"],"properties":{"agentId":{"type":"string","description":"The identifier of the Sigma agent to run in this workbook."},"effect":{"type":"string","enum":["call-agent"]},"prompt":{"type":"string","description":"The instructions passed to the agent when the action runs."}}},{"type":"object","properties":{"actionVariables":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the action variable for the agent to return the value from."},"type":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["integer"]},{"type":"string","enum":["boolean"]},{"type":"string","enum":["datetime"]}],"description":"Scalar data type of the action variable."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the action variable."}}}]},"description":"The action variables populated from the agent response."}}}]},"description":"The actions that run when the schedule triggers."},"id":{"type":"string","description":"The stable identifier for this automated action sequence."},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"The cron expression that determines when the scheduled action runs. E.g., `0 9 * * 1` runs every Monday at 9:00 AM."},"timezone":{"type":"string","description":"The IANA timezone used to evaluate the cron expression."}},"description":"The configuration of a recurring schedule. Includes a cron expression and timezone."},"trigger":{"type":"string","enum":["schedule"],"description":"Runs the automated action sequence on a recurring schedule."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for the automated action sequence."},"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the automated action sequence is turned on or off."}}}]},"description":"The action sequences that run automatically on a schedule or webhook trigger."}}}]},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["workbook"],"description":"Document kind. Always `workbook` for this resource."}}}]},{"type":"object","required":["layout"],"properties":{"layout":{"type":"string","description":"Grid layout as XML.","title":"Layout XML"}}}],"description":"The code representation of the workbook: its pages, elements, columns, sources, layout, and theme. Submit this object as the `document` field of a create or update request to reproduce the workbook. Everything outside `document` is workbook metadata that Sigma maintains, and is ignored when you write.","title":"Workbook Document"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"put":{"summary":"Update a workbook from a code representation (Beta)","description":"This endpoint replaces a workbook with a workbook defined in a code representation. You can programmatically update the workbook's structure, metadata, and contents. This creates a new version of the workbook, which is accessible from the Sigma UI.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### System and user requirements\n- To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish workbooks** permission.\n- To perform this operation, you must use API credentials owned by a user with **Can edit** access for the workbook.\n\n### Usage notes\n- The default format of the representation is YAML. To use JSON, add the header `Content-Type: application/json`.\n- You can define the layout of contents on the workbook page using XML in the `document.layout` field. For more information, see [Customize the layout of a workbook in code representation](https://help.sigmacomputing.com/docs/customize-the-layout-of-a-workbook-in-code-representation).\n- You can combine multiple YAML documents to create one workbook representation. For more information, see [Prepare a representation from multiple YAML documents](https://help.sigmacomputing.com/docs/create-a-workbook-from-a-code-representation#prepare-a-representation-from-multiple-yaml-documents).\n- To retrieve the representation of an existing workbook, use the [/v2/workbooks/{workbookId}/spec](https://help.sigmacomputing.com/reference/get-workbook-spec) endpoint.\n- To create a new workbook from code, use the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint.\n- When `documentVersion` is provided in the request body, the update fails when the workbook has changed since that version. If omitted, the update preserves last-write-wins behavior.\n- The endpoint only supports updates to the `document` object and its contents. Workbook metadata sent alongside `document` -- including `name`, `folderId`, and `description` -- is ignored, so you can submit a response from the [GET spec](https://help.sigmacomputing.com/reference/get-workbook-spec) endpoint unchanged. To rename or move a workbook, use the [/v2/files/{fileId}](https://help.sigmacomputing.com/reference/updatefile) endpoint.\n- Partial updates are not supported. You must provide the entire representation of the workbook in the request body.\n\n### Usage scenarios\n- **Agentic workflows**: Agents can use these endpoints to directly manage workbook contents in code.\n- **Automation**: If you want to update several workbooks across one or more organizations, or in response to external events, you can use this endpoint to programmatically update the workbooks.\n- **Integration**: Using this endpoint, you can update workbooks based on external data sources or integrate Sigma with other tools and platforms.\n","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"updateWorkbookSpec","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["document"],"properties":{"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the workbook."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["workbook"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages of the workbook."}}},{"type":"object","required":["elements"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/WorkbookElement"},"description":"The elements in this workbook and their definitions."}}},{"type":"object","properties":{"overlays":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the modal page."},"type":{"type":"string","enum":["modal"],"description":"Marks this page as a modal."},"name":{"type":"string","description":"The name of the modal."}}},{"type":"object","properties":{"modal":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"footer":{"type":"object","properties":{"primaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The primary footer button."},"secondaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The secondary footer button."}},"description":"The footer with primary and secondary buttons."}}}],"description":"The modal presentation options, including width, header, and footer buttons."},"singleRowContainer":{"allOf":[{"type":"object","required":["source","keyColumnId"],"properties":{"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source that supplies the displayed row."},"keyColumnId":{"type":"string","description":"The ID of the source column that identifies which row is displayed. Must be a column declared on the source."}}},{"type":"object","properties":{"keyColumnValue":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The key-column value of the row to display. Must match the key column type. Omit to pin no row."}}}],"description":"Pins the modal to one row of a source: the elements inside it show that row. Omit for an ordinary modal."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions on the modal. Each action's `trigger` must be one of `on-primary-cta-click`, `on-secondary-cta-click`, or `on-close`."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The background image for the modal. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Modal"},{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the drawer page."},"type":{"type":"string","enum":["drawer"],"description":"Marks this page as a drawer."},"name":{"type":"string","description":"The name of the drawer."}}},{"type":"object","properties":{"drawer":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"showShadow":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to display the drawer as a page overlay, dimming the page behind it when open. Either `shown` to dim the background page or `hidden` for none."}}}],"description":"The presentation of the drawer, including width, header, and page overlay."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by the drawer, on close."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"Background image for the drawer. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Drawer"},{"allOf":[{"type":"object","required":["id","type","name","popover"],"properties":{"id":{"type":"string","description":"The identifier of the popover page."},"type":{"type":"string","enum":["popover"],"description":"Marks this page as a popover."},"name":{"type":"string","description":"The name of the popover."},"popover":{"allOf":[{"type":"object","required":["triggerElementId"],"properties":{"triggerElementId":{"type":"string","description":"The identifier of the button that triggers the popover."}}},{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"Popover width breakpoint: x-small, small, medium, large, or x-large."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"padding":{"type":"string","enum":["none"],"description":"Set to 'none' to remove padding from the popover."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Gap between popover elements: 'shown' (default) or 'hidden'."}}}],"description":"Popover presentation: trigger button, width, spacing, padding, and element gap."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions fired by the popover when it closes."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Popover"}]},"description":"The modals, drawers, and popovers in this workbook and their contents."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page header."},"type":{"type":"string","enum":["header"],"description":"Identifies this panel as a page header."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the header."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["shadow"]},{"type":"string","enum":["none"]}],"description":"The border drawn below the header. One of `line`, `shadow`, or `none`. `shadow` applies only when `scroll` is `sticky`."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The header presentation, including scroll behavior, border, background, and height."}}}],"title":"PageHeader"},{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page sidebar."},"type":{"type":"string","enum":["sidebar"],"description":"Identifies this panel as a page sidebar."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the sidebar."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"width":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Sidebar width preset. One of `small` (200px), `medium` (260px), or `large` (400px). Defaults to `medium`."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["none"]}],"description":"The border style for the sidebar."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The sidebar presentation, including scroll behavior, border, and background color."}}}],"title":"PageSidebar"}]},"description":"The definitions of page headers and sidebars in this document."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}},{"type":"object","properties":{"agents":{"type":"array","items":{"allOf":[{"type":"object","required":["id","instructions"],"properties":{"id":{"type":"string","description":"The identifier of the agent."},"instructions":{"type":"string","description":"Instructions that guide the agent. Use `{{formula}}` for dynamic values, `@dataSource(\"elementId\")` for configured data sources, and `@tool(\"toolId\")` for configured tools."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the agent."},"description":{"type":"string","description":"The description of the agent."},"greeting":{"oneOf":[{"type":"object","required":["mode","message"],"properties":{"mode":{"type":"string","enum":["static"]},"message":{"type":"string","description":"The first message an agent displays when the chat opens. Not generated by the AI provider. Supports dynamic `{{formula}}` text."}},"description":"","title":"Fixed greeting"},{"type":"object","required":["mode","prompt"],"properties":{"mode":{"type":"string","enum":["generated"]},"prompt":{"type":"string","description":"The prompt the agent uses to generate the first message displayed when the chat opens. Supports dynamic `{{formula}}` text."}},"description":"","title":"Generated greeting"}],"description":"The greeting message for the agent. Set `mode` to `static` with a `message`, or `generated` with a `prompt`. Omit for the product default."},"dataSources":{"type":"array","items":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of a workbook element, such as a table or chart, the agent can read from."}},"description":"","title":"Workbook element"},"description":"The data elements or data model tables the agent can access."},"tools":{"type":"array","items":{"oneOf":[{"type":"object","required":["toolId","kind","connectorId","name"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["mcp-connector"]},"connectorId":{"type":"string","description":"The UUID of the MCP connector."},"name":{"type":"string","description":"The display name of the MCP connector."}},"description":"","title":"MCP connector"},{"allOf":[{"type":"object","required":["toolId","kind"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["warehouse-agent"]}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of when the agent should invoke this warehouse agent."}}}],"description":"","title":"Warehouse agent"},{"allOf":[{"type":"object","required":["toolId","kind","description"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["search-service"]},"description":{"type":"string","description":"A description of what this search service can retrieve, used by the agent to decide when to call it."}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}}],"description":"","title":"Search service"},{"allOf":[{"type":"object","required":["toolId","kind","name","description","steps"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["action"]},"name":{"type":"string","description":"The display name of the action tool."},"description":{"type":"string","description":"A description of what this tool does and when the agent should invoke it."},"steps":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["kind","sequenceId"],"properties":{"kind":{"type":"string","enum":["sequence"]},"sequenceId":{"type":"string","description":"The identifier of an action sequence in the workbook."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"","title":"Sequence reference"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["effect"]}}},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"An action effect to run. Effects that depend on user interaction, such as a selected row or column, are not supported.","title":"Inline effect"}]},"description":"The steps the agent runs when it invokes this action tool."}}},{"type":"object","properties":{"requiresApproval":{"type":"boolean","description":"Whether the agent must pause to get user approval before running this tool. Defaults to `false`."}}}],"description":"","title":"Action"}]},"description":"The tools the agent can invoke to take action or enrich insights."}}}]},"description":"The agents defined in the workbook. Reference one from a chat element using `agentId`."}}},{"type":"object","properties":{"automatedActions":{"type":"array","items":{"allOf":[{"type":"object","required":["effects","id","schedule","trigger"],"properties":{"effects":{"type":"array","items":{"allOf":[{"type":"object","required":["agentId","effect","prompt"],"properties":{"agentId":{"type":"string","description":"The identifier of the Sigma agent to run in this workbook."},"effect":{"type":"string","enum":["call-agent"]},"prompt":{"type":"string","description":"The instructions passed to the agent when the action runs."}}},{"type":"object","properties":{"actionVariables":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the action variable for the agent to return the value from."},"type":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["integer"]},{"type":"string","enum":["boolean"]},{"type":"string","enum":["datetime"]}],"description":"Scalar data type of the action variable."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the action variable."}}}]},"description":"The action variables populated from the agent response."}}}]},"description":"The actions that run when the schedule triggers."},"id":{"type":"string","description":"The stable identifier for this automated action sequence."},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"The cron expression that determines when the scheduled action runs. E.g., `0 9 * * 1` runs every Monday at 9:00 AM."},"timezone":{"type":"string","description":"The IANA timezone used to evaluate the cron expression."}},"description":"The configuration of a recurring schedule. Includes a cron expression and timezone."},"trigger":{"type":"string","enum":["schedule"],"description":"Runs the automated action sequence on a recurring schedule."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for the automated action sequence."},"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the automated action sequence is turned on or off."}}}]},"description":"The action sequences that run automatically on a schedule or webhook trigger."}}}]},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["workbook"],"description":"Document kind. Always `workbook` for this resource."}}}]},{"type":"object","required":["layout"],"properties":{"layout":{"type":"string","description":"Grid layout as XML.","title":"Layout XML"}}}],"description":"The code representation of the workbook to write: its pages, elements, columns, sources, layout, and theme.","title":"Workbook Document"}}},{"type":"object","properties":{"documentVersion":{"type":"number","description":"When provided, update only if the workbook is still at this document version."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["success","workbookId"],"properties":{"success":{"type":"boolean"},"workbookId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/swapSources":{"post":{"summary":"Swap workbook data sources","description":"Swap the data sources used by a workbook. You can swap from one connection to another, and/or from one dataset or table to another.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - Retrieve the sources used by a workbook from the [v2/workbooks/{workbookId}/sources](https://help.sigmacomputing.com/reference/get-workbook-sources) endpoint.\n\n  - To swap all tables in a connection, set the `swapTables` option to `true`.\n\n    - Use the `paths` option to specify the connection paths to swap. The connection path is a list of strings that represents the path to the table in the cloud data warehouse. For example, `[\"database\", \"schema\", \"table\"]`.\n    - If the table schema is the same in both connections, leave the `paths` option empty to swap all tables in the connection. You can also pass a partial path to swap between databases, catalogs, or schemas.\n    - If `sourceMapping` is provided, those mappings take precedence over the connection swaps.\n    - If `swapTables` is not set to `true`, only Custom SQL elements have their connections changed.\n\n  ### Usage scenarios\n  - **Workbook development**: Use a test data source while developing a workbook, then swap the source to a production database when ready to share the workbook for production use.\n    ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"sourceSwapWorkbook","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"sourceMapping":{"type":"array","items":{"allOf":[{"type":"object","required":["fromId","toId"],"properties":{"fromId":{"type":"string","description":"ID of the dataset (deprecated) or table to swap from.","title":"Data source ID"},"toId":{"type":"string","description":"ID of the dataset (deprecated) or table to swap to.","title":"Data source ID"}}},{"type":"object","properties":{"metricMapping":{"type":"array","items":{"type":"object","required":["fromMetric","toMetric"],"properties":{"fromMetric":{"type":"string","description":"Metric in the data source.","title":"Metric name"},"toMetric":{"type":"string","description":"Metric in the data source.","title":"Metric name"}}}},"columnMapping":{"type":"array","items":{"type":"object","required":["fromColumn","toColumn"],"properties":{"fromColumn":{"oneOf":[{"type":"string","description":"Column in the data source.","title":"Column name"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link of the form [\"link_name\", \"column_name\"]","title":"Link"}]},"toColumn":{"oneOf":[{"type":"string","description":"Column in the data source.","title":"Column name"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link of the form [\"link_name\", \"column_name\"]","title":"Link"}]}}}}}}]}},"connectionMapping":{"type":"array","items":{"allOf":[{"type":"object","required":["fromId","toId"],"properties":{"fromId":{"type":"string","description":"ID of the connection to swap from.","title":"Connection ID"},"toId":{"type":"string","description":"ID of the connection to swap to.","title":"Connection ID"}}},{"type":"object","properties":{"swapTables":{"type":"boolean","description":"Whether to swap all tables in the connection","title":"Swap Tables"},"paths":{"type":"array","items":{"type":"object","required":["fromPath","toPath"],"properties":{"fromPath":{"type":"array","items":{"type":"string"},"description":"Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE']","title":"From Path"},"toPath":{"type":"array","items":{"type":"string"},"description":"Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE']","title":"To Path"}}}}}}]}},"copyInputTableData":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["unswappedSources","unswappedConnections"],"properties":{"unswappedSources":{"type":"array","items":{"type":"string"},"description":"IDs of sources in the workbook that were not swapped."},"unswappedConnections":{"type":"array","items":{"type":"string"},"description":"IDs of custom SQL connections in the workbook that were not swapped."}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/tag/{versionTag}/copy":{"post":{"summary":"Duplicate a tagged workbook","description":"This endpoint lets you duplicate a tagged workbook, creating a new workbook from the tagged version. The workbook copy can be placed in a different folder from the original workbook, potentially with a different name and description. This is useful for creating workbook templates or backups.\n### Usage notes\n- The workbookId and version tag in the URL specify the tagged version of the workbook to duplicate. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. For the **versionTag**, you can specify either the tag name or ID. Retrieve the version tag name or ID by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint.\n- The `destinationFolderId` in the request body specifies where to place the new workbook.\n  - To use the \"My Documents\" folder for a specific user as the destination folder, call the [/v2/members/{memberId}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response.\n  - Retrieve the **folderId** of all folders by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n### Best practices\n- Always verify that the destination folder has the correct permissions set to avoid access issues.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"versionTag","schema":{"type":"string","description":"The id or name of the version tag to use.","title":"versionTag"},"in":"path","required":true}],"operationId":"copyTaggedWorkbook","requestBody":{"description":"Body parameters for copying a workbook.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["destinationFolderId","name"],"properties":{"destinationFolderId":{"type":"string","description":"ID of the folder in which to place the copied workbook.","title":"Destination Folder ID"},"name":{"type":"string","description":"Name for the copied workbook as it appears in Sigma.","title":"New Workbook Name"}}},{"type":"object","properties":{"description":{"type":"string","description":"A description for the new workbook.","title":"New Description"},"copyBookmarks":{"type":"string","enum":["all","accessible"],"description":"If set to `all` (available to admins only), every saved view (bookmark) applied to the workbook is copied. If set to `accessible`, only personal saved views and those shared with the user initiating the operation are copied. Ownership of all saved views in the duplicate workbook transfers to the user initiating the operation. If not set, saved views are not copied.","title":"Copy Bookmarks"}}}],"description":"Body parameters for copying a workbook."}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["workbookId","workbookUrlId","name","url","path","latestVersion","ownerId"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"workbookUrlId":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"path":{"type":"string"},"latestVersion":{"type":"number","description":"The most recently published document version of the workbook."},"ownerId":{"type":"string"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}},{"type":"object","properties":{"isArchived":{"type":"boolean"},"tags":{"type":"array","items":{"type":"object","required":["versionTagId","name","sourceWorkbookVersion","taggedWorkbookId","workbookTaggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"name":{"type":"string"},"sourceWorkbookVersion":{"type":"number"},"taggedWorkbookId":{"type":"string","description":"Unique identifier of the tagged workbook.","title":"Workbook ID"},"workbookTaggedAt":{"type":"string","format":"date-time"}}}},"description":{"type":"string"},"taggedSourceUrlId":{"type":"string","description":"For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/tags":{"get":{"summary":"Get tags for a workbook","description":"Retrieve the version tag information for a workbook. Returns the same tag metadata as the [GET /v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint returns for a tagged workbook.\n  ### Usage notes\n  - Use this endpoint to provide on-demand access to version tag information for a workbook. For example, call the [GET /v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint with the \"excludeTags\" parameter set to `True` to improve performance, then use this endpoint to return tag information for specific workbooks.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getWorkbookTags","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["versionTagId","name","sourceWorkbookVersion","taggedWorkbookId","workbookTaggedAt"],"properties":{"versionTagId":{"type":"string","description":"Unique identifier of the tag.","title":"Tag ID"},"name":{"type":"string"},"sourceWorkbookVersion":{"type":"number"},"taggedWorkbookId":{"type":"string","description":"Unique identifier of the tagged workbook.","title":"Workbook ID"},"workbookTaggedAt":{"type":"string","format":"date-time"}}}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/tags/{tagId}":{"delete":{"summary":"Remove a tag from a workbook","description":"This endpoint removes a specific version tag from a workbook. Version tags are used to mark workbooks for certain stages or characteristics. Removing a version tag can help manage and update the organizational scheme of workbooks as projects evolve or conclude.\n\n  ### Usage notes\n  - **workbookId:** The unique identifier for the workbook to remove the tag from. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - **tagId:** The unique identifier for the tag to remove. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.\n\n  ### Usage scenarios\n  - **Organizational updates:** Useful for administrators who need to update tagging schemes as project requirements change.\n  - **Data management:** Helps in maintaining the relevance and organization of workbook metadata for easier access and identification.\n\n  ### Best practices\n  - Verify that the correct tag is being removed by reviewing its associated workbooks and the implications of its removal.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"tagId","schema":{"type":"string","description":"Unique identifier of the version tag","title":"tagId"},"in":"path","required":true}],"operationId":"deleteTaggedworkbook","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/tags/{tagName}/bookmarks":{"get":{"summary":"List bookmarks in a tagged workbook","description":"Returns a list of bookmarks in a tagged workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"tagName","schema":{"type":"string"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getTaggedWorkbookBookmarks","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["bookmarkId","name","isShared","exploreKey"],"properties":{"bookmarkId":{"type":"string"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}},{"type":"object","properties":{"isDefault":{"type":"boolean","description":"Whether the bookmark is default."}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/":{"post":{"summary":"Add a bookmark to a tagged workbook","description":"Add a bookmark to a version tagged workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n- Retrieve the **workbookVersion** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version.\n- Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"tagName","schema":{"type":"string"},"in":"path","required":true}],"operationId":"createTaggedWorkbookBookmark","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["workbookVersion","name","isShared","exploreKey"],"properties":{"workbookVersion":{"type":"number"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["bookmarkId","name","isShared","exploreKey"],"properties":{"bookmarkId":{"type":"string"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}},{"type":"object","properties":{"isDefault":{"type":"boolean","description":"Whether the bookmark is default."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/{bookmarkId}":{"get":{"summary":"Get a bookmark in a tagged workbook","description":"Retrieve details for a bookmark in a tagged workbook based on bookmarkId\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"tagName","schema":{"type":"string"},"in":"path","required":true},{"name":"bookmarkId","schema":{"type":"string","description":"Unique identifier of the bookmark.","title":"Bookmark ID"},"in":"path","required":true}],"operationId":"getTaggedWorkbookBookmark","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["bookmarkId","name","isShared","exploreKey"],"properties":{"bookmarkId":{"type":"string"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}},{"type":"object","properties":{"isDefault":{"type":"boolean","description":"Whether the bookmark is default."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"patch":{"summary":"Update a bookmark in a tagged workbook","description":"Update a bookmark in a version tagged workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n- Retrieve the **workbookVersion** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version.\n- Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"tagName","schema":{"type":"string"},"in":"path","required":true},{"name":"bookmarkId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"updateTaggedWorkbookBookmark","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":["string","null"]},"isShared":{"type":["boolean","null"]},"isDefault":{"type":["boolean","null"]},"exploreKey":{"type":["string","null"],"description":"ID of the associated exploration."}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["bookmarkId","name","isShared","exploreKey"],"properties":{"bookmarkId":{"type":"string"},"name":{"type":"string"},"isShared":{"type":"boolean","description":"Whether the bookmark is shared."},"exploreKey":{"type":"string","description":"ID of the associated exploration."}}},{"type":"object","properties":{"isDefault":{"type":"boolean","description":"Whether the bookmark is default."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]},"delete":{"summary":"Delete a bookmark from a tagged workbook","description":"Delete a bookmark from a version tagged workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n  ","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"tagName","schema":{"type":"string"},"in":"path","required":true},{"name":"bookmarkId","schema":{"type":"string","description":"Unique identifier of the bookmark.","title":"Bookmark ID"},"in":"path","required":true}],"operationId":"deleteTaggedWorkbookBookmark","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/{workbookId}/version-history":{"get":{"summary":"Get version history for a workbook","description":"Get version history for a workbook given the workbookId. If the version history contains any tagged versions, the response includes information about the version tag.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"getVersionHistory","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["version","publishedAt","publishedBy"],"properties":{"version":{"type":"number"},"publishedAt":{"type":"string","format":"date-time"},"publishedBy":{"type":"string"}}},{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","required":["versionTagId","taggedAt","taggedBy"],"properties":{"versionTagId":{"type":"string"},"taggedAt":{"type":"string","format":"date-time"},"taggedBy":{"type":"string"}}}}}}]}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/spec":{"post":{"summary":"Create a workbook from a code representation (Beta)","description":"This endpoint creates a new workbook from a code representation. Use it to programmatically define and create workbooks that are then accessible from the Sigma UI.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\nFor more information on managing workbooks programmatically, see [Manage workbooks as code](https://help.sigmacomputing.com/docs/manage-workbooks-as-code). For more information on using this endpoint, including end-to-end instructions, see [Create a workbook from a code representation](https://help.sigmacomputing.com/docs/create-a-workbook-from-a-code-representation).\n\n### System and user requirements\n- To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish workbooks** permission.\n- To perform this operation, you must use API credentials owned by a user with **Can edit** access for the workbook.\n\n### Usage notes\n- You can define the layout of contents on the workbook page using XML in the `document.layout` field. For more information, see [Customize the layout of a workbook in code representation](https://help.sigmacomputing.com/docs/customize-the-layout-of-a-workbook-in-code-representation).\n- You can combine multiple YAML documents to create one workbook representation. For more information, see [Prepare a representation from multiple YAML documents](https://help.sigmacomputing.com/docs/create-a-workbook-from-a-code-representation#prepare-a-representation-from-multiple-yaml-documents).\n- To retrieve the representation of an existing workbook, use the [/v2/workbooks/{workbookId}/spec](https://help.sigmacomputing.com/reference/get-workbook-spec) endpoint.\n- To update an existing workbook from code, use the [/v2/workbooks/{workbookId}/spec](https://help.sigmacomputing.com/reference/update-workbook-spec) endpoint.\n- To get a list of folders, call the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and review the `id` field in the response for files with a `type` of `folder`.\n\n### Usage scenarios\n- **Agentic workflows**: Agents can use these endpoints to directly manage workbook contents in code.\n- **Automation**: If you want to create several workbooks across one or more organizations, you can use this endpoint to programmatically create the workbooks.\n- **Integration**: Using this endpoint, you can create workbooks based on external data sources or integrate Sigma with other tools and platforms.\n- **Migration**: You can use this endpoint to migrate workbooks from one organization to another.\n","parameters":[],"operationId":"createWorkbookSpec","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name","folderId","document"],"properties":{"name":{"type":"string","description":"The name of the workbook."},"folderId":{"type":"string","description":"The identifier of the folder in which the workbook is located."},"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the workbook."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["workbook"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages of the workbook."}}},{"type":"object","required":["elements"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/WorkbookElement"},"description":"The elements in this workbook and their definitions."}}},{"type":"object","properties":{"overlays":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the modal page."},"type":{"type":"string","enum":["modal"],"description":"Marks this page as a modal."},"name":{"type":"string","description":"The name of the modal."}}},{"type":"object","properties":{"modal":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"footer":{"type":"object","properties":{"primaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The primary footer button."},"secondaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The secondary footer button."}},"description":"The footer with primary and secondary buttons."}}}],"description":"The modal presentation options, including width, header, and footer buttons."},"singleRowContainer":{"allOf":[{"type":"object","required":["source","keyColumnId"],"properties":{"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source that supplies the displayed row."},"keyColumnId":{"type":"string","description":"The ID of the source column that identifies which row is displayed. Must be a column declared on the source."}}},{"type":"object","properties":{"keyColumnValue":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The key-column value of the row to display. Must match the key column type. Omit to pin no row."}}}],"description":"Pins the modal to one row of a source: the elements inside it show that row. Omit for an ordinary modal."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions on the modal. Each action's `trigger` must be one of `on-primary-cta-click`, `on-secondary-cta-click`, or `on-close`."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The background image for the modal. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Modal"},{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the drawer page."},"type":{"type":"string","enum":["drawer"],"description":"Marks this page as a drawer."},"name":{"type":"string","description":"The name of the drawer."}}},{"type":"object","properties":{"drawer":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"showShadow":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to display the drawer as a page overlay, dimming the page behind it when open. Either `shown` to dim the background page or `hidden` for none."}}}],"description":"The presentation of the drawer, including width, header, and page overlay."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by the drawer, on close."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"Background image for the drawer. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Drawer"},{"allOf":[{"type":"object","required":["id","type","name","popover"],"properties":{"id":{"type":"string","description":"The identifier of the popover page."},"type":{"type":"string","enum":["popover"],"description":"Marks this page as a popover."},"name":{"type":"string","description":"The name of the popover."},"popover":{"allOf":[{"type":"object","required":["triggerElementId"],"properties":{"triggerElementId":{"type":"string","description":"The identifier of the button that triggers the popover."}}},{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"Popover width breakpoint: x-small, small, medium, large, or x-large."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"padding":{"type":"string","enum":["none"],"description":"Set to 'none' to remove padding from the popover."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Gap between popover elements: 'shown' (default) or 'hidden'."}}}],"description":"Popover presentation: trigger button, width, spacing, padding, and element gap."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions fired by the popover when it closes."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Popover"}]},"description":"The modals, drawers, and popovers in this workbook and their contents."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page header."},"type":{"type":"string","enum":["header"],"description":"Identifies this panel as a page header."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the header."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["shadow"]},{"type":"string","enum":["none"]}],"description":"The border drawn below the header. One of `line`, `shadow`, or `none`. `shadow` applies only when `scroll` is `sticky`."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The header presentation, including scroll behavior, border, background, and height."}}}],"title":"PageHeader"},{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page sidebar."},"type":{"type":"string","enum":["sidebar"],"description":"Identifies this panel as a page sidebar."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the sidebar."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"width":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Sidebar width preset. One of `small` (200px), `medium` (260px), or `large` (400px). Defaults to `medium`."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["none"]}],"description":"The border style for the sidebar."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The sidebar presentation, including scroll behavior, border, and background color."}}}],"title":"PageSidebar"}]},"description":"The definitions of page headers and sidebars in this document."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}},{"type":"object","properties":{"agents":{"type":"array","items":{"allOf":[{"type":"object","required":["id","instructions"],"properties":{"id":{"type":"string","description":"The identifier of the agent."},"instructions":{"type":"string","description":"Instructions that guide the agent. Use `{{formula}}` for dynamic values, `@dataSource(\"elementId\")` for configured data sources, and `@tool(\"toolId\")` for configured tools."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the agent."},"description":{"type":"string","description":"The description of the agent."},"greeting":{"oneOf":[{"type":"object","required":["mode","message"],"properties":{"mode":{"type":"string","enum":["static"]},"message":{"type":"string","description":"The first message an agent displays when the chat opens. Not generated by the AI provider. Supports dynamic `{{formula}}` text."}},"description":"","title":"Fixed greeting"},{"type":"object","required":["mode","prompt"],"properties":{"mode":{"type":"string","enum":["generated"]},"prompt":{"type":"string","description":"The prompt the agent uses to generate the first message displayed when the chat opens. Supports dynamic `{{formula}}` text."}},"description":"","title":"Generated greeting"}],"description":"The greeting message for the agent. Set `mode` to `static` with a `message`, or `generated` with a `prompt`. Omit for the product default."},"dataSources":{"type":"array","items":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of a workbook element, such as a table or chart, the agent can read from."}},"description":"","title":"Workbook element"},"description":"The data elements or data model tables the agent can access."},"tools":{"type":"array","items":{"oneOf":[{"type":"object","required":["toolId","kind","connectorId","name"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["mcp-connector"]},"connectorId":{"type":"string","description":"The UUID of the MCP connector."},"name":{"type":"string","description":"The display name of the MCP connector."}},"description":"","title":"MCP connector"},{"allOf":[{"type":"object","required":["toolId","kind"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["warehouse-agent"]}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of when the agent should invoke this warehouse agent."}}}],"description":"","title":"Warehouse agent"},{"allOf":[{"type":"object","required":["toolId","kind","description"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["search-service"]},"description":{"type":"string","description":"A description of what this search service can retrieve, used by the agent to decide when to call it."}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}}],"description":"","title":"Search service"},{"allOf":[{"type":"object","required":["toolId","kind","name","description","steps"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["action"]},"name":{"type":"string","description":"The display name of the action tool."},"description":{"type":"string","description":"A description of what this tool does and when the agent should invoke it."},"steps":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["kind","sequenceId"],"properties":{"kind":{"type":"string","enum":["sequence"]},"sequenceId":{"type":"string","description":"The identifier of an action sequence in the workbook."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"","title":"Sequence reference"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["effect"]}}},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"An action effect to run. Effects that depend on user interaction, such as a selected row or column, are not supported.","title":"Inline effect"}]},"description":"The steps the agent runs when it invokes this action tool."}}},{"type":"object","properties":{"requiresApproval":{"type":"boolean","description":"Whether the agent must pause to get user approval before running this tool. Defaults to `false`."}}}],"description":"","title":"Action"}]},"description":"The tools the agent can invoke to take action or enrich insights."}}}]},"description":"The agents defined in the workbook. Reference one from a chat element using `agentId`."}}},{"type":"object","properties":{"automatedActions":{"type":"array","items":{"allOf":[{"type":"object","required":["effects","id","schedule","trigger"],"properties":{"effects":{"type":"array","items":{"allOf":[{"type":"object","required":["agentId","effect","prompt"],"properties":{"agentId":{"type":"string","description":"The identifier of the Sigma agent to run in this workbook."},"effect":{"type":"string","enum":["call-agent"]},"prompt":{"type":"string","description":"The instructions passed to the agent when the action runs."}}},{"type":"object","properties":{"actionVariables":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the action variable for the agent to return the value from."},"type":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["integer"]},{"type":"string","enum":["boolean"]},{"type":"string","enum":["datetime"]}],"description":"Scalar data type of the action variable."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the action variable."}}}]},"description":"The action variables populated from the agent response."}}}]},"description":"The actions that run when the schedule triggers."},"id":{"type":"string","description":"The stable identifier for this automated action sequence."},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"The cron expression that determines when the scheduled action runs. E.g., `0 9 * * 1` runs every Monday at 9:00 AM."},"timezone":{"type":"string","description":"The IANA timezone used to evaluate the cron expression."}},"description":"The configuration of a recurring schedule. Includes a cron expression and timezone."},"trigger":{"type":"string","enum":["schedule"],"description":"Runs the automated action sequence on a recurring schedule."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for the automated action sequence."},"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the automated action sequence is turned on or off."}}}]},"description":"The action sequences that run automatically on a schedule or webhook trigger."}}}]},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["workbook"],"description":"Document kind. Always `workbook` for this resource."}}}]},{"type":"object","required":["layout"],"properties":{"layout":{"type":"string","description":"Grid layout as XML.","title":"Layout XML"}}}],"description":"The code representation of the workbook to write: its pages, elements, columns, sources, layout, and theme.","title":"Workbook Document"}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the workbook."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["success","workbookId"],"properties":{"success":{"type":"boolean"},"workbookId":{"type":"string"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/spec/verify":{"post":{"summary":"Verify a workbook code representation (Beta)","description":"This endpoint validates a workbook code representation without creating or modifying any workbook. It performs the same validation as the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint but never persists the result, so you can confirm a representation is valid before creating a workbook from it.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### System and user requirements\n- To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish workbooks** permission.\n\n### Usage notes\n- The response `valid` field indicates whether the representation passed validation. When `valid` is `false`, the `errors` array describes each validation failure.\n- The request body is identical to the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint.\n- No workbook is created and no data is persisted by this endpoint.\n\n### Usage scenarios\n- **Agentic workflows**: Agents can validate a generated representation before committing it to a create or update operation.\n- **Automation**: Validate representations in CI or migration tooling before applying them.\n","parameters":[],"operationId":"verifyWorkbookSpec","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name","folderId","document"],"properties":{"name":{"type":"string","description":"The name of the workbook."},"folderId":{"type":"string","description":"The identifier of the folder in which the workbook is located."},"document":{"allOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["schemaVersion"],"properties":{"schemaVersion":{"type":"number","enum":[1],"description":"The schema version used by this representation of the workbook."}}},{"type":"object","properties":{"kind":{"type":"string","enum":["workbook"],"description":"The document kind. Ignored when creating or updating."}}},{"allOf":[{"type":"object","required":["pages"],"properties":{"pages":{"type":"array","items":{"allOf":[{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"The identifier of the page in the workbook."},"name":{"type":"string","description":"The name of the page."}}},{"type":"object","required":[],"properties":{}},{"type":"object","properties":{"type":{"type":"string","enum":["page"],"description":"The page type, distinguishing a regular page from a `modal`, `drawer`, or `popover`. Only `page` can be set. If omitted, `page` is assumed."},"visibility":{"oneOf":[{"type":"string","enum":["hidden"]},{"type":"object","required":["kind","assignments"],"properties":{"kind":{"type":"string","enum":["specific-users-and-teams"]},"assignments":{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"},"description":"The identifiers of the users allowed to view this page."},"teams":{"type":"array","items":{"type":"string"},"description":"The identifiers of the teams allowed to view this page."}},"description":"The identifiers of the users and teams allowed to view this page."}}}],"description":"The visibility settings for the page. If omitted, the page is visible to all users. Specify `hidden` to hide the page, or define `{ kind: 'specific-users-and-teams', assignments: { users: [...], teams: [...] } }` to limit visibility to particular users and teams."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The page background image. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"object","required":["mode","maxWidth"],"properties":{"mode":{"type":"string","enum":["custom"]},"maxWidth":{"type":"number","description":"The fixed page width in pixels, when `mode` is `custom`."}}}],"description":"The width of the page. One of `full`, `large`, `medium`, or `{ mode: 'custom', maxWidth }` for a fixed pixel width."}}}],"title":"Page"},"description":"The pages of the workbook."}}},{"type":"object","required":["elements"],"properties":{"elements":{"type":"array","items":{"$ref":"#/components/schemas/WorkbookElement"},"description":"The elements in this workbook and their definitions."}}},{"type":"object","properties":{"overlays":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the modal page."},"type":{"type":"string","enum":["modal"],"description":"Marks this page as a modal."},"name":{"type":"string","description":"The name of the modal."}}},{"type":"object","properties":{"modal":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"footer":{"type":"object","properties":{"primaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The primary footer button."},"secondaryCta":{"type":"object","properties":{"visible":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the button is shown."},"text":{"type":"string","description":"The button label. Supports dynamic `{{formula}}` text."}},"description":"The secondary footer button."}},"description":"The footer with primary and secondary buttons."}}}],"description":"The modal presentation options, including width, header, and footer buttons."},"singleRowContainer":{"allOf":[{"type":"object","required":["source","keyColumnId"],"properties":{"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["metric-view"]}}}],"description":"A Databricks metric view, referenced by connection and warehouse path.","title":"Metric View"},{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["semantic-view"]}}}],"description":"A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table.","title":"Semantic View"},{"type":"object","required":["connectionId","kind","statement"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["sql"]},"statement":{"type":"string","description":"The custom SQL statement used in the element."}},"description":"","title":"Custom SQL"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"},{"type":"object","required":["kind","elementId","output"],"properties":{"kind":{"type":"string","enum":["code-output"]},"elementId":{"type":"string","description":"The identifier of the code (Python) element whose output to display."},"output":{"type":"string","description":"Name of the code element's output — the sigma.output('name', …) name — to display."}},"description":"A table produced by a code (Python) element via sigma.output.","title":"Code Output"},{"allOf":[{"type":"object","required":["kind","joins"],"properties":{"kind":{"type":"string","enum":["join"]},"joins":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right","columns"],"properties":{"left":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the left table in the join."},"right":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The name of the right table in the join."},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["left","right"],"properties":{"left":{"type":"string","description":"The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."},"right":{"type":"string","description":"The column reference or formula expression from the right source used in the join.  E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”."}}},{"type":"object","properties":{"op":{"oneOf":[{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">="]},{"type":"string","enum":[">"]},{"type":"string","enum":["within"]},{"type":"string","enum":["intersects"]},{"type":"string","enum":["is-distinct-from"]},{"type":"string","enum":["is-not-distinct-from"]}],"description":"The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type."}}}]},"description":"A list of the column pairs and operators that define this join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the right."},"joinType":{"oneOf":[{"type":"string","enum":["inner"]},{"type":"string","enum":["left-outer"]},{"type":"string","enum":["right-outer"]},{"type":"string","enum":["full-outer"]},{"type":"string","enum":["lookup"]}],"description":"The logical join type."}}}]},"description":"A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join."}}},{"type":"object","properties":{"name":{"type":"string","description":"The name of the join. Defaults to the name of the primary source."},"primarySource":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right."}}}],"description":"","title":"Join"},{"type":"object","required":["kind","sources","matches"],"properties":{"kind":{"type":"string","enum":["union"]},"sources":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}]},"description":"The identifiers of the sources in the union."},"matches":{"type":"array","items":{"type":"object","required":["outputColumnName","sourceColumns"],"properties":{"outputColumnName":{"type":"string","description":"The name of the union output column."},"sourceColumns":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":"The matching set of source columns that correspond to the union output column."}}},"description":"The union output columns and the matched source columns that comprise them."}},"description":"","title":"Union"},{"allOf":[{"type":"object","required":["kind","source"],"properties":{"kind":{"type":"string","enum":["transpose"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The identifier of the source in the transpose."}}},{"oneOf":[{"type":"object","required":["direction","outputColumns","columnToTranspose","valueColumn","aggregate"],"properties":{"direction":{"type":"string","enum":["row-to-column"]},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The list of columns in the transposed table."},"columnToTranspose":{"type":"string","description":"The identifier of the column whose values are used as column headings."},"valueColumn":{"type":"string","description":"The identifier of the column used to calculate cell values for each row in the transposed columns."},"aggregate":{"oneOf":[{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["count"]},{"type":"string","enum":["count-if"]},{"type":"string","enum":["count-distinct"]},{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]}],"description":"Indicates the calculation performed on the valueColumn."}}},{"type":"object","required":["direction","columnsToMerge","columnLabelForMergedColumns","columnLabelForValues"],"properties":{"direction":{"type":"string","enum":["column-to-row"]},"columnsToMerge":{"type":"array","items":{"type":"string"},"description":"The list of columns to merge in the transposed table. Must be of the same data type."},"columnLabelForMergedColumns":{"type":"string","description":"The display name of the merged column in the transposed table."},"columnLabelForValues":{"type":"string","description":"The display name of the column of transposed values."}}}]}],"description":"","title":"Transpose"},{"allOf":[{"type":"object","required":["kind","source","arrayColumn","valueColumn","outputColumns"],"properties":{"kind":{"type":"string","enum":["unnest"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["warehouse-table"]}}}],"description":"","title":"Warehouse Table"},{"type":"object","required":["connectionId","kind","inodeId"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"kind":{"type":"string","enum":["csv-table"]},"inodeId":{"type":"string","description":"The identifier of the table created from a CSV."}},"description":"","title":"CSV Table"},{"allOf":[{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of the table in this data model."}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Table"},{"allOf":[{"type":"object","required":["dataModelId","elementId","kind"],"properties":{"dataModelId":{"type":"string","description":"The identifier of the data model source."},"elementId":{"type":"string","description":"The identifier of the table in the referenced data model."},"kind":{"type":"string","enum":["data-model"]}}},{"type":"object","properties":{"groupingId":{"type":"string","description":"The identifier of the grouping to apply to the table."}}}],"description":"","title":"Data Model"}],"description":"The source containing the array column to unnest."},"arrayColumn":{"type":"string","description":"The variant column containing arrays to unnest."},"valueColumn":{"type":"string","description":"The name of the generated column containing array values."},"outputColumns":{"type":"array","items":{"type":"string"},"description":"The columns included in the unnest output."}}},{"type":"object","properties":{"indexColumn":{"type":"string","description":"The name of the generated zero-based array index column."},"preserveAllSourceRows":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether to preserve rows whose array column is null or empty."}}}],"description":"","title":"Unnest"}],"description":"The data source that supplies the displayed row."},"keyColumnId":{"type":"string","description":"The ID of the source column that identifies which row is displayed. Must be a column declared on the source."}}},{"type":"object","properties":{"keyColumnValue":{"oneOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"string","description":"","title":"Fixed Date"}],"description":"The key-column value of the row to display. Must match the key column type. Omit to pin no row."}}}],"description":"Pins the modal to one row of a source: the elements inside it show that row. Omit for an ordinary modal."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions on the modal. Each action's `trigger` must be one of `on-primary-cta-click`, `on-secondary-cta-click`, or `on-close`."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"The background image for the modal. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Modal"},{"allOf":[{"type":"object","required":["id","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the drawer page."},"type":{"type":"string","enum":["drawer"],"description":"Marks this page as a drawer."},"name":{"type":"string","description":"The name of the drawer."}}},{"type":"object","properties":{"drawer":{"allOf":[{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"The overlay width."},"header":{"type":"object","properties":{"title":{"type":"string","description":"The header title. Supports dynamic `{{formula}}` text."},"showCloseIcon":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether the header shows the close button."}},"description":"The header configuration, including title text and close-icon visibility."}}},{"type":"object","properties":{"showShadow":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to display the drawer as a page overlay, dimming the page behind it when open. Either `shown` to dim the background page or `hidden` for none."}}}],"description":"The presentation of the drawer, including width, header, and page overlay."},"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"The actions triggered by the drawer, on close."},"backgroundImage":{"allOf":[{"type":"object","required":["source"],"properties":{"source":{"oneOf":[{"type":"object","required":["kind","url"],"properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string","description":"The external image URL. Supports dynamic `{{formula}}` text."}},"description":"An external image referenced by URL. Supports dynamic `{{formula}}` text.","title":"External URL"},{"type":"object","required":["kind","key"],"properties":{"kind":{"type":"string","enum":["upload"]},"key":{"type":"string","description":"The identifier for an image uploaded to Sigma."}},"description":"A reference to a previously uploaded image. New images cannot be uploaded via this endpoint.","title":"Uploaded Image"}],"description":"The image source. Either an external URL (supports dynamic `{{formula}}` text) or an image uploaded into Sigma."}}},{"type":"object","properties":{"style":{"type":"object","properties":{"fit":{"oneOf":[{"type":"string","enum":["contain"]},{"type":"string","enum":["cover"]},{"type":"string","enum":["none"]},{"type":"string","enum":["scale-down"]},{"type":"string","enum":["stretch"]}],"description":"How the image fits the container."},"horizontalAlign":{"oneOf":[{"type":"string","enum":["left"]},{"type":"string","enum":["center"]},{"type":"string","enum":["right"]}],"description":"The horizontal alignment of the image within its container."},"verticalAlign":{"oneOf":[{"type":"string","enum":["top"]},{"type":"string","enum":["center"]},{"type":"string","enum":["bottom"]}],"description":"The vertical alignment of the image within its container."},"tiling":{"oneOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["repeat"]}],"description":"The tiling behavior for the image. `none` displays a single image (default). `repeat` tiles the image to fill the container."}},"description":"The image sizing and alignment within the element."}}}],"description":"Background image for the drawer. The URL supports dynamic `{{formula}}` text."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Drawer"},{"allOf":[{"type":"object","required":["id","type","name","popover"],"properties":{"id":{"type":"string","description":"The identifier of the popover page."},"type":{"type":"string","enum":["popover"],"description":"Marks this page as a popover."},"name":{"type":"string","description":"The name of the popover."},"popover":{"allOf":[{"type":"object","required":["triggerElementId"],"properties":{"triggerElementId":{"type":"string","description":"The identifier of the button that triggers the popover."}}},{"type":"object","properties":{"width":{"oneOf":[{"type":"string","enum":["x-small"]},{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]},{"type":"string","enum":["x-large"]}],"description":"Popover width breakpoint: x-small, small, medium, large, or x-large."},"spacing":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."},"padding":{"type":"string","enum":["none"],"description":"Set to 'none' to remove padding from the popover."},"elementGap":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Gap between popover elements: 'shown' (default) or 'hidden'."}}}],"description":"Popover presentation: trigger button, width, spacing, padding, and element gap."}}},{"type":"object","properties":{"actions":{"allOf":[{"$ref":"#/components/schemas/Actions"}],"description":"Actions fired by the popover when it closes."},"backgroundColor":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"The page background color. A hex code, `rgb()` value, or theme reference."}}}],"title":"Popover"}]},"description":"The modals, drawers, and popovers in this workbook and their contents."}}},{"type":"object","properties":{"panels":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page header."},"type":{"type":"string","enum":["header"],"description":"Identifies this panel as a page header."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the header."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["shadow"]},{"type":"string","enum":["none"]}],"description":"The border drawn below the header. One of `line`, `shadow`, or `none`. `shadow` applies only when `scroll` is `sticky`."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The header presentation, including scroll behavior, border, background, and height."}}}],"title":"PageHeader"},{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the page sidebar."},"type":{"type":"string","enum":["sidebar"],"description":"Identifies this panel as a page sidebar."}}},{"type":"object","properties":{"title":{"type":"string","description":"The display name of the sidebar."},"pages":{"type":"array","items":{"type":"string"},"description":"Ids of the pages this panel is applied to. A page may have at most one header and one sidebar, and only normal pages can carry panels (not modals or drawers). Omit when the panel is defined but unassigned."},"width":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"Sidebar width preset. One of `small` (200px), `medium` (260px), or `large` (400px). Defaults to `medium`."},"config":{"type":"object","properties":{"scroll":{"oneOf":[{"type":"string","enum":["sticky"]},{"type":"string","enum":["none"]}],"description":"How the panel behaves as the page scrolls. 'sticky' pins it in place; 'none' lets it scroll away. Defaults to 'sticky'."},"borderStyle":{"oneOf":[{"type":"string","enum":["line"]},{"type":"string","enum":["none"]}],"description":"The border style for the sidebar."},"backgroundColor":{"type":"string","description":"Panel background color. Omit to follow the theme."}},"description":"The sidebar presentation, including scroll behavior, border, and background color."}}}],"title":"PageSidebar"}]},"description":"The definitions of page headers and sidebars in this document."}}}]}]},{"type":"object","properties":{"settings":{"type":"object","properties":{"theme":{"type":"object","properties":{"name":{"oneOf":[{"oneOf":[{"type":"string","enum":["Light"]},{"type":"string","enum":["Dark"]},{"type":"string","enum":["Surface"]}]},{"type":"string"}],"description":"The name of a built-in theme (`Light`, `Dark`, or `Surface`) or the UUID of an organization theme. Omit to use the organization default theme, or `Light` when the organization has no default."},"overrides":{"type":"object","properties":{"borderRadius":{"oneOf":[{"type":"string","enum":["square"]},{"type":"string","enum":["round"]},{"type":"string","enum":["pill"]}],"description":"The corner shape. Omit to inherit the workbook theme."},"categoricalScheme":{"oneOf":[{"type":"string","description":"Named categorical palette.","title":"Named palette"},{"type":"array","items":{"type":"string"},"description":"Custom hex color list.","title":"Custom palette"}],"description":"The categorical color palette, as a palette name or custom hex array. Defaults to `superbloom`."},"colorOverrides":{"type":"array","items":{"type":"object","required":["name","color"],"properties":{"name":{"type":"string","description":"ColorTheme slot name (matches the theme color inspector, e.g. backgroundCanvas)."},"color":{"type":"string"}}},"description":"Overrides for particular layout theme colors as hex codes. Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)."},"colors":{"type":"object","properties":{"text":{"type":"string","description":"The primary text color, as a hex code."},"highlight":{"type":"string","description":"The highlight or accent color, as a hex code. Maps to the theme's `$primary` color."},"surface":{"type":"string","description":"The surface color, as a hex code."},"success":{"type":"string","description":"The success color, as a hex code."},"warning":{"type":"string","description":"The warning color, as a hex code."},"danger":{"type":"string","description":"The danger color, as a hex code."},"darkMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether dark color mode is on. Defaults to `hidden`."}}},"divergingScheme":{"type":"string","description":"The named diverging color scheme. Defaults to `blueorange`."},"elementBorder":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"width":{"type":"number","description":"Element border width in pixels (0–3)."}}},"fonts":{"type":"object","properties":{"dataFont":{"type":"string","description":"The font family for workbook data. Defaults to `Roboto`."},"textFont":{"type":"string","description":"The font family for non-data text, like element titles, descriptions, and table headers."}}},"hasCards":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements are framed as cards (with a border, background, and padding). Defaults to `shown`."},"invertTooltipColors":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether to invert text and background colors in visualization tooltips. Defaults to `shown`."},"layoutColors":{"type":"object","properties":{"useElementForeground":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether elements render above the canvas."}}},"maxPageWidth":{"type":"number","description":"Max page width in pixels when pageWidth is custom (minimum 600)."},"pageWidth":{"oneOf":[{"type":"string","enum":["full"]},{"type":"string","enum":["large"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["custom"]}],"description":"The page content width."},"sequentialScheme":{"type":"string","description":"The named sequential color scheme. Defaults to `blues`."},"space":{"type":"object","properties":{"showElementPadding":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether padding around elements is shown. Defaults to `shown`."},"unit":{"oneOf":[{"type":"string","enum":["small"]},{"type":"string","enum":["medium"]},{"type":"string","enum":["large"]}],"description":"The element spacing preset."}}},"tableStyles":{"$ref":"#/components/schemas/TableStyle"},"titleFont":{"type":"object","properties":{"color":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"object","required":["kind","ref"],"properties":{"kind":{"type":"string","enum":["theme"]},"ref":{"type":"string"}}}],"description":"A hex color (`#rgb` or `#rrggbb`), an `rgb()` value (e.g. `rgb(0, 0, 255)`), or a theme color reference. `rgba()` is not supported."},"fontSize":{"type":"number","description":"Title font size in pixels (6–96)."},"fontWeight":{"oneOf":[{"type":"string","enum":["normal"]},{"type":"string","enum":["bold"]}]}}}},"description":"Customizations applied on top of the base theme selected by `name`, or the document's default theme when `name` is omitted."}},"description":"The document theme. Either the name of a theme in the organization or a built-in theme. Optionally, applies per-field overrides to the theme for colors and fonts.","title":"Theme"},"navigation":{"type":"object","properties":{"pageHeader":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page headers are enabled in the workbook. Defaults to `disabled`. A page also needs a header panel assigned before one renders."},"pageSidebar":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether page sidebars are enabled in the workbook. Defaults to `disabled`. A page also needs a sidebar panel assigned before one renders."},"primary":{"oneOf":[{"type":"string","enum":["sidebar"]},{"type":"string","enum":["header"]}],"description":"Which panel overlays the other when a page has both a header and a sidebar. If panels have different scroll styles, the fixed panel overlays the scrolling panel. Defaults to `sidebar`."},"pageTabsInViewMode":{"oneOf":[{"type":"string","enum":["shown"]},{"type":"string","enum":["hidden"]}],"description":"Whether viewers see the page tab bar. Defaults to `shown`."}},"description":"The workbook navigation settings for page headers, page sidebars, and page tabs. Omitting it drops any previously stored navigation settings."}},"description":"The document-level settings. Accepts `theme`, and `navigation` on a workbook. A report accepts `theme` alone.","title":"Document Settings"}}},{"type":"object","properties":{"agents":{"type":"array","items":{"allOf":[{"type":"object","required":["id","instructions"],"properties":{"id":{"type":"string","description":"The identifier of the agent."},"instructions":{"type":"string","description":"Instructions that guide the agent. Use `{{formula}}` for dynamic values, `@dataSource(\"elementId\")` for configured data sources, and `@tool(\"toolId\")` for configured tools."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the agent."},"description":{"type":"string","description":"The description of the agent."},"greeting":{"oneOf":[{"type":"object","required":["mode","message"],"properties":{"mode":{"type":"string","enum":["static"]},"message":{"type":"string","description":"The first message an agent displays when the chat opens. Not generated by the AI provider. Supports dynamic `{{formula}}` text."}},"description":"","title":"Fixed greeting"},{"type":"object","required":["mode","prompt"],"properties":{"mode":{"type":"string","enum":["generated"]},"prompt":{"type":"string","description":"The prompt the agent uses to generate the first message displayed when the chat opens. Supports dynamic `{{formula}}` text."}},"description":"","title":"Generated greeting"}],"description":"The greeting message for the agent. Set `mode` to `static` with a `message`, or `generated` with a `prompt`. Omit for the product default."},"dataSources":{"type":"array","items":{"type":"object","required":["kind","elementId"],"properties":{"kind":{"type":"string","enum":["table"]},"elementId":{"type":"string","description":"The identifier of a workbook element, such as a table or chart, the agent can read from."}},"description":"","title":"Workbook element"},"description":"The data elements or data model tables the agent can access."},"tools":{"type":"array","items":{"oneOf":[{"type":"object","required":["toolId","kind","connectorId","name"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["mcp-connector"]},"connectorId":{"type":"string","description":"The UUID of the MCP connector."},"name":{"type":"string","description":"The display name of the MCP connector."}},"description":"","title":"MCP connector"},{"allOf":[{"type":"object","required":["toolId","kind"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["warehouse-agent"]}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"description":{"type":"string","description":"A description of when the agent should invoke this warehouse agent."}}}],"description":"","title":"Warehouse agent"},{"allOf":[{"type":"object","required":["toolId","kind","description"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["search-service"]},"description":{"type":"string","description":"A description of what this search service can retrieve, used by the agent to decide when to call it."}}},{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}}],"description":"","title":"Search service"},{"allOf":[{"type":"object","required":["toolId","kind","name","description","steps"],"properties":{"toolId":{"type":"string","description":"The identifier of the tool within this agent. Must not contain '[', ']', '/', or '\\', and must not have leading or trailing whitespace."},"kind":{"type":"string","enum":["action"]},"name":{"type":"string","description":"The display name of the action tool."},"description":{"type":"string","description":"A description of what this tool does and when the agent should invoke it."},"steps":{"type":"array","items":{"oneOf":[{"allOf":[{"type":"object","required":["kind","sequenceId"],"properties":{"kind":{"type":"string","enum":["sequence"]},"sequenceId":{"type":"string","description":"The identifier of an action sequence in the workbook."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"","title":"Sequence reference"},{"allOf":[{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["effect"]}}},{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["effect","connectorId"],"properties":{"effect":{"type":"string","enum":["call-api"]},"connectorId":{"type":"string","description":"The ID of the API connector to call."}}},{"type":"object","properties":{"arguments":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Values to send to the API connector, keyed by parameter name."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls an API connector with configured values.","title":"Call API"},{"allOf":[{"allOf":[{"type":"object","required":["effect","openTarget"],"properties":{"effect":{"type":"string","enum":["open-url"]},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the URL opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."}}},{"type":"object","properties":{"url":{"type":"string","description":"The URL to open. Supports dynamic `{{formula}}` text."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a URL in the same tab, a new tab, or the parent frame.","title":"Open URL"},{"allOf":[{"type":"object","required":["effect","overlayId"],"properties":{"effect":{"type":"string","enum":["open-overlay"]},"overlayId":{"type":"string","description":"The identifier of the modal or drawer to open."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens a modal.","title":"Open Overlay"},{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["close-overlay"]}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Closes the currently open modal.","title":"Close Overlay"},{"allOf":[{"allOf":[{"type":"object","required":["effect","control","value"],"properties":{"effect":{"type":"string","enum":["set-control-value"]},"control":{"type":"string","description":"The control ID of the control to update with a new value."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"description":"The value to set on the control."}}},{"type":"object","properties":{"selectionMode":{"oneOf":[{"type":"string","enum":["replace"]},{"type":"string","enum":["add"]},{"type":"string","enum":["remove"]}],"description":"How the value combines with the current selection. Defaults to `replace`."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets a control's value, optionally combining with the current selection.","title":"Set Control Value"},{"allOf":[{"allOf":[{"type":"object","required":["effect","scope"],"properties":{"effect":{"type":"string","enum":["clear-control"]},"scope":{"oneOf":[{"type":"object","required":["type","controlId"],"properties":{"type":{"type":"string","enum":["control"]},"controlId":{"type":"string"}},"description":"Clear a single control by its control ID.","title":"Control"},{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Clear every control in a container by the container element ID.","title":"Container"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["page"]}}},{"type":"object","properties":{"pageId":{"type":"string"}}}],"description":"Clear every control on a page by page ID, or the current page when omitted.","title":"Page"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"Clear every control in the workbook.","title":"Workbook"}],"description":"The scope of controls to clear. One of a specific `control`, all controls in a `container` or `page`, or the entire `workbook`."}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears one or more controls to empty or their published value.","title":"Clear Control"},{"allOf":[{"allOf":[{"type":"object","required":["effect"],"properties":{"effect":{"type":"string","enum":["reset-form"]}}},{"type":"object","properties":{"usePublishedValue":{"type":"boolean","description":"Whether to reset to the published value instead of clearing to empty."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Resets all fields in the host form to empty or published values.","title":"Reset Form"},{"allOf":[{"type":"object","required":["effect","formElementId","values"],"properties":{"effect":{"type":"string","enum":["set-form-values"]},"formElementId":{"type":"string","description":"The element id of the target form to set."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Form fieldId -> the value to write into that field on the target form."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets one or more values on a target form.","title":"Set Form Values"},{"allOf":[{"type":"object","required":["effect","target","value"],"properties":{"effect":{"type":"string","enum":["set-single-row-container"]},"target":{"oneOf":[{"type":"object","required":["type","containerElementId"],"properties":{"type":{"type":"string","enum":["container"]},"containerElementId":{"type":"string"}},"description":"Set a single-row container element by its container element ID.","title":"Container"},{"type":"object","required":["type","modalId"],"properties":{"type":{"type":"string","enum":["modal"]},"modalId":{"type":"string"}},"description":"Set the single-row container displayed in a modal, by the modal page ID.","title":"Modal"}],"description":"The single-row container to set."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The key-column value of the row to display."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sets the row a single-row container displays.","title":"Set Single Row Container"},{"allOf":[{"type":"object","required":["effect","chatElementId"],"properties":{"effect":{"type":"string","enum":["clear-chat-element-messages"]},"chatElementId":{"type":"string","description":"The chat element whose message history to clear."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Clears a chat element's message history.","title":"Clear Chat Element Messages"},{"allOf":[{"allOf":[{"type":"object","required":["effect","storedProcedure"],"properties":{"effect":{"type":"string","enum":["call-stored-procedure"]},"storedProcedure":{"allOf":[{"type":"object","required":["connectionId","path"],"properties":{"connectionId":{"type":"string","description":"The identifier of the connection to the data platform."},"path":{"type":"array","items":{"type":"string"},"description":"The path of the object in the data platform."}}},{"type":"object","properties":{"signature":{"type":"string","description":"Stored procedure signature to run, using the display text shown in the workbook action editor."}}}],"description":"Stored procedure to run, identified by its connection and warehouse path."}}},{"type":"object","properties":{"arguments":{"type":"array","items":{"type":"object","required":["parameterIndex","type","value"],"properties":{"parameterIndex":{"type":"number","description":"Identifies which stored procedure input this argument supplies, using 0 for the first parameter."},"type":{"type":"string","enum":["boolean","datetime","number","integer","text"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}}},"description":"Values to pass to stored procedure inputs. Omitted inputs will be filled with default values for their parameter type."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Calls a stored procedure.","title":"Call Stored Procedure"},{"allOf":[{"type":"object","required":["effect","tableElementId","values"],"properties":{"effect":{"type":"string","enum":["insert-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table. Cannot be a linked input table."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The identifier of the column in the target table to write to and the value to write. Omitted columns keep the table's default."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Inserts a row into a target input table.","title":"Insert Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows","values"],"properties":{"effect":{"type":"string","enum":["update-rows"]},"tableElementId":{"type":"string","description":"The identifier of the target input table element. Can reference a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to update in the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The values to write into matched rows, specified by column ID."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Updates matched rows in a target input table.","title":"Update Rows"},{"allOf":[{"type":"object","required":["effect","tableElementId","whichRows"],"properties":{"effect":{"type":"string","enum":["delete-rows"]},"tableElementId":{"type":"string","description":"The input table to delete rows from. Cannot be a linked input table."},"whichRows":{"oneOf":[{"type":"object","required":["type","primaryKeys"],"properties":{"type":{"type":"string","enum":["single-row"]},"primaryKeys":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"}}},"description":"Matches one row by its primary-key columns. Set `type` to `single-row`, with `primaryKeys` mapping each primary-key column ID to the value to match it against."},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["current-row"]}},"description":"The row that triggered the action."},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"Whether to match rows where a formula over the target table's columns is true. Set `type` to `formula` and `formula` to the expression."},{"allOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column-match"]},"columnId":{"type":"string"}}},{"oneOf":[{"type":"object","required":["condition"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["IsNull"]},{"type":"string","enum":["IsNotNull"]}]}}},{"type":"object","required":["condition","value"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["="]},{"type":"string","enum":["!="]},{"type":"string","enum":[">"]},{"type":"string","enum":[">="]},{"type":"string","enum":["<"]},{"type":"string","enum":["<="]},{"type":"string","enum":["Contains"]},{"type":"string","enum":["NotContains"]},{"type":"string","enum":["StartsWith"]},{"type":"string","enum":["EndsWith"]}]},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}},{"type":"object","required":["condition","low","high"],"properties":{"condition":{"oneOf":[{"type":"string","enum":["Between"]},{"type":"string","enum":["NotBetween"]}]},"low":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"high":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}}}]}],"description":"Whether to match rows where the target table column meets the condition. Set `type` to `column-match`, `columnId` to the column, and `condition` to a comparison operator with `value`, `IsNull`/`IsNotNull`, or `Between`/`NotBetween` with `low` and `high`."}],"description":"The rows to delete from the input table. Set `type` to `single-row` with `primaryKeys` to match one row by its key columns, `current-row` for the row the trigger fired from, `formula` with a `formula` over the table's columns, or `column-match` with a `columnId` and `condition`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Deletes matched rows from a target input table.","title":"Delete Rows"},{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["effect","channel","recipients","subject","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["email"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"subject":{"type":"string","description":"The email subject. Supports dynamic-text {{formula}} values."},"messageBody":{"type":"string","description":"The email body. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}},{"type":"object","properties":{"ccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients copied on the email."},"bccRecipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}],"description":"Recipients blind-copied on the email."},"runAsRecipient":{"type":"boolean","description":"Render the export using each recipient's own permissions. Defaults to false."},"zipAttachments":{"type":"boolean","description":"Compress the attachments into a single zip file. Defaults to false."}}}],"description":"Send a notification by email.","title":"Email notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["slack"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Slack message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Slack.","title":"Slack notification"},{"allOf":[{"type":"object","required":["effect","channel","recipients","messageBody"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["ms-teams"]},"recipients":{"oneOf":[{"type":"object","required":["type","values"],"properties":{"type":{"type":"string","enum":["static"]},"values":{"type":"array","items":{"type":"string"}}},"description":"A fixed list of notification destinations.","title":"Static Recipients"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["dynamic"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}]}},"description":"Notification destinations resolved from an action value source.","title":"Dynamic Recipients"}]},"messageBody":{"type":"string","description":"The Microsoft Teams message. Supports dynamic-text {{formula}} values."}}},{"type":"object","properties":{"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]},"includeLink":{"type":"boolean","description":"Include a link back to this document in the message. Defaults to false."},"linkTo":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["workbook"]}},"description":"The entire document.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this document.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this document.","title":"Element"}],"description":"Where the included link opens. Defaults to the entire document when includeLink is true."},"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Send a notification to Microsoft Teams.","title":"Microsoft Teams notification"},{"allOf":[{"type":"object","required":["effect","channel","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["download"]},"source":{"oneOf":[{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},{"type":"object","required":["type","documentId"],"properties":{"type":{"type":"string","enum":["external-report"]},"documentId":{"type":"string"}},"description":"An external report.","title":"External Report"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Comma-separated values.","title":"CSV"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"includeMetadata":{"type":"boolean"},"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}],"description":"Microsoft Excel workbook.","title":"Excel"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}},"description":"JSON data.","title":"JSON"},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}},"description":"PDF document.","title":"PDF"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}},"description":"PNG image.","title":"PNG"}]}}},{"type":"object","properties":{"controlValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"Control values applied to the exported content and any included link, keyed by controlId."}}}],"description":"Export content for browser download.","title":"Browser download"},{"type":"object","required":["effect","channel","endpoints","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["webhook"]},"endpoints":{"type":"array","items":{"type":"string"},"description":"The webhook endpoints that receive the export."},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}}]}},"description":"Send exported content to a webhook.","title":"Webhook export"},{"type":"object","required":["effect","channel","folderUrl","source","format"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["sharepoint"]},"folderUrl":{"type":"string","description":"The SharePoint folder URL that receives the export."},"source":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"The whole workbook.","title":"Workbook"},{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"A page in this workbook.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"An element in this workbook.","title":"Element"}]},"format":{"oneOf":[{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["csv"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["excel"]}}},{"type":"object","properties":{"repeatHeaderLabels":{"type":"boolean","description":"Repeat each pivot row or column header label in its own cell."}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["json"]}}},{"type":"object","required":["type","layout","pageSize"],"properties":{"type":{"type":"string","enum":["pdf"]},"layout":{"oneOf":[{"type":"string","enum":["landscape"]},{"type":"string","enum":["portrait"]}]},"pageSize":{"oneOf":[{"type":"string","enum":["letter"]},{"type":"string","enum":["legal"]},{"type":"string","enum":["tabloid"]},{"type":"string","enum":["a0"]},{"type":"string","enum":["a1"]},{"type":"string","enum":["a2"]},{"type":"string","enum":["a3"]},{"type":"string","enum":["a4"]}]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["png"]}}}]}},"description":"Send exported content to SharePoint.","title":"SharePoint export"},{"allOf":[{"type":"object","required":["effect","channel","source","uri"],"properties":{"effect":{"type":"string","enum":["export"]},"channel":{"type":"string","enum":["cloud-storage"]},"source":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}}},"uri":{"type":"string","description":"The cloud storage URI, e.g. `s3://bucket/path`."}}},{"type":"object","properties":{"cloudStorageAccess":{"type":"string","description":"The cloud storage access configuration: a Snowflake storage integration or Redshift IAM role. Omit for a Snowflake external-stage URI."},"gzip":{"type":"boolean","description":"Compress the exported file with gzip."},"prefixTimestamp":{"type":"boolean","description":"Prefix the exported file name with the current date and time."}}}],"description":"Export content to cloud storage through the data warehouse.","title":"Cloud storage export"}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a notification or exports workbook content.","title":"Notify and Export"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["refresh-element"]},"target":{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The element to refresh. Refreshing a parent element also refreshes its child elements."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Refreshes a single element's data. Does not apply to materialized elements.","title":"Refresh Element"},{"allOf":[{"type":"object","required":["effect","target"],"properties":{"effect":{"type":"string","enum":["navigate"]},"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The page or element to navigate to."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Navigates to a page or element in this workbook.","title":"Navigate"},{"allOf":[{"allOf":[{"type":"object","required":["effect","documentId","openTarget","documentType"],"properties":{"effect":{"type":"string","enum":["open-document"]},"documentId":{"type":"string","description":"The identifier of the workbook or report to open."},"openTarget":{"oneOf":[{"type":"string","enum":["_self"]},{"type":"string","enum":["_blank"]},{"type":"string","enum":["_parent"]}],"description":"Where the document opens. One of `_self` (same tab), `_blank` (new tab), or `_parent` (parent frame)."},"documentType":{"oneOf":[{"type":"string","enum":["workbook"]},{"type":"string","enum":["report"]}],"description":"The type of document to open."}}},{"type":"object","properties":{"target":{"oneOf":[{"type":"object","required":["type","page"],"properties":{"type":{"type":"string","enum":["page"]},"page":{"type":"string"}},"description":"The identifier of the page to navigate to.","title":"Page"},{"type":"object","required":["type","element"],"properties":{"type":{"type":"string","enum":["element"]},"element":{"type":"string"}},"description":"The identifier of the element to navigate to.","title":"Element"}],"description":"The identifier of a page or element to open inside the target document. Values are passed through as specified without validation."},"targetControls":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"description":"","title":"Text list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"number"}]}}},"description":"","title":"Number list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"null"},{"type":"string","description":"The selected date to filter on, in ISO 8601 format."}]}}},"description":"","title":"Date list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean-list"]},"value":{"type":"array","items":{"oneOf":[{"type":"string","enum":["is-true"]},{"type":"string","enum":["is-false"]},{"type":"string","enum":["is-null"]}]}}},"description":"","title":"Boolean list"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number-range"]},"value":{"type":"object","properties":{"min":{"type":"number","description":"The lower bound of the selected number range."},"max":{"type":"number","description":"The upper bound of the selected number range."}}}},"description":"","title":"Number range"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date-range"]},"value":{"oneOf":[{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["between"]},"startDate":{"type":"string","description":"The start date of the date range, in ISO 8601 format."},"endDate":{"type":"string","description":"The end date of the date range, in ISO 8601 format."}}},{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["between"]}}}],"description":"","title":"Between"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["on"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"On"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["before"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"Before"},{"type":"object","required":["mode","date"],"properties":{"mode":{"type":"string","enum":["after"]},"date":{"type":"string","description":"The date to filter to, in ISO 8601 format."}},"description":"","title":"After"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["next"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Next"},{"type":"object","required":["mode","value","unit","includeToday"],"properties":{"mode":{"type":"string","enum":["last"]},"value":{"type":"number","description":"The number of units to filter on. I.e. 'x units ago'."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"includeToday":{"type":"boolean","description":"Whether to include the current date in the range. Defaults to `false`."}},"description":"","title":"Last"},{"type":"object","required":["mode","unit"],"properties":{"mode":{"type":"string","enum":["current"]},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."}},"description":"","title":"Current"},{"oneOf":[{"type":"object","required":["mode","startDate","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The start date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."},"endDate":{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}],"description":"The end date of the date range, in ISO 8601 format (e.g., `2017-08-26T00:00:00Z`) or relative format (e.g., Today, Last 7 Days)."}}},{"type":"object","required":["mode","startDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"startDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The start date of the date range, expressed relative to today (e.g., 7 days ago). Use this variant when the end date is unbounded."}}},{"type":"object","required":["mode","endDate"],"properties":{"mode":{"type":"string","enum":["custom"]},"endDate":{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"The end date of the date range, expressed relative to today (e.g., 7 days from now). Use this variant when the start date is unbounded."}}}],"description":"","title":"Custom"}]}},"description":"","title":"Date range"}]}},"description":"A literal value, of the same data type as the target control.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"},{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string"}},"description":"A column ID on the host element's source. Only valid on a select trigger.","title":"Column"},{"type":"object","required":["type","fieldId"],"properties":{"type":{"type":"string","enum":["form-field"]},"fieldId":{"type":"string"}},"description":"A form field's current value. Set `fieldId` to the form field's `fieldId`. Only valid in form actions.","title":"FormField"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["column-range"]}}},{"type":"object","properties":{"minColumnId":{"type":"string"},"maxColumnId":{"type":"string"}}}],"description":"The column IDs on the host element's source that provide the lower and upper bounds of a range control, on select triggers. Set either bound alone for an open-ended range.","title":"ColumnRange"},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["formula-range"]}}},{"type":"object","properties":{"min":{"type":"string"},"max":{"type":"string"}}}],"description":"A pair of formula expressions providing the lower and upper bounds of a range control, on select triggers.","title":"FormulaRange"},{"type":"object","required":["type","inputName"],"properties":{"type":{"type":"string","enum":["agent-input"]},"inputName":{"type":"string","description":"The label for the value provided by the agent, e.g. 'Customer name'."}},"description":"A value provided by an agent when it runs this action. Use only with an action tool for an agent.","title":"AgentInput"}],"type":"object"},"description":"The set of controls in the target document and the values to set them to when the document is opened, as key-value pairs. Keys name inputs in the target document. Values must be specified from the current workbook."}}}]},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Opens another workbook or report.","title":"Open Document"},{"allOf":[{"type":"object","required":["effect","tabbedContainerElementId","selectedTab"],"properties":{"effect":{"type":"string","enum":["select-tab"]},"tabbedContainerElementId":{"type":"string","description":"The tabbed container element to select a tab in."},"selectedTab":{"oneOf":[{"type":"object","required":["type","direction"],"properties":{"type":{"type":"string","enum":["direction"]},"direction":{"oneOf":[{"type":"string","enum":["next"]},{"type":"string","enum":["previous"]}]}},"description":"Selects a tab relative to the currently active tab.","title":"Direction"},{"type":"object","required":["type","index"],"properties":{"type":{"type":"string","enum":["tab"]},"index":{"type":"number","description":"The 0-based index into the tabbed container's tab order. The first tab is `0`."}},"description":"The 0-based index of the tab to display in the tabbed container. The first tab is `0`.","title":"Tab"}],"description":"The tab to select. Set `type` to `direction` with a `direction` (`next` or `previous`), or `tab` with a 0-based `index`."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Selects a tab on a tabbed container.","title":"Select Tab"},{"allOf":[{"type":"object","required":["effect","elementId","sort"],"properties":{"effect":{"type":"string","enum":["custom-sort"]},"elementId":{"type":"string","description":"The element to sort."},"sort":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnId","direction"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"by":{"type":"string","description":"The identifier of the column to sort by. Can be set to `row-count` to sort by the number of rows. If omitted, sorts by the column's own values."},"aggregation":{"oneOf":[{"type":"string","enum":["sum"]},{"type":"string","enum":["avg"]},{"type":"string","enum":["median"]},{"type":"string","enum":["count"]},{"type":"string","enum":["countDistinct"]},{"type":"string","enum":["min"]},{"type":"string","enum":["max"]},{"type":"string","enum":["stddev"]},{"type":"string","enum":["variance"]}],"description":"Aggregation function for the sort. Only valid when `by` references a column ID (not \"row-count\")."},"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How null values sort. Omit, or use 'connection-default', for the connection's default null ordering."}}}]},{"type":"object","required":["type","columns"],"properties":{"type":{"type":"string","enum":["level"]},"columns":{"type":"array","items":{"allOf":[{"type":"object","required":["columnId","direction"],"properties":{"columnId":{"type":"string","description":"The identifier of the column by which to sort."},"direction":{"oneOf":[{"type":"string","enum":["ascending"]},{"type":"string","enum":["descending"]}],"description":"The sort direction."}}},{"type":"object","properties":{"nulls":{"oneOf":[{"type":"string","enum":["first"]},{"type":"string","enum":["last"]},{"type":"string","enum":["connection-default"]}],"description":"How the sort order treats null values."}}}]},"description":"Ordered list of columns to sort by."}}}],"description":"The sort to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sorts a chart (or pivot table) by one of its columns, or a Table's rows by an ordered list of columns.","title":"Custom Sort"},{"allOf":[{"type":"object","required":["effect","elementId","modification"],"properties":{"effect":{"type":"string","enum":["modify-element"]},"elementId":{"type":"string","description":"The element to modify."},"modification":{"oneOf":[{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["move-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["base"]}},"title":"Base destination"}],"description":"Where to move the column."},"source":{"oneOf":[{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"title":"Column source"},{"allOf":[{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}},{"type":"object","properties":{"matchOrder":{"type":"boolean","description":"Order the moved column(s) to match the control's selected-value order. Requires a multi-select control."}}}]}],"description":"The column to move, or a control whose selected values determine which columns to move."}}},{"type":"object","required":["type","destination","source"],"properties":{"type":{"type":"string","enum":["swap-column"]},"destination":{"oneOf":[{"type":"object","required":["type","channel"],"properties":{"type":{"type":"string","enum":["channel"]},"channel":{"oneOf":[{"type":"string","enum":["x-axis"]},{"type":"string","enum":["y-axis"]},{"type":"string","enum":["measure"]},{"type":"string","enum":["comparison"]},{"type":"string","enum":["hole-value"]},{"type":"string","enum":["color-category"]},{"type":"string","enum":["color-scale"]},{"type":"string","enum":["split-by"]},{"type":"string","enum":["label"]},{"type":"string","enum":["tooltip"]},{"type":"string","enum":["row"]},{"type":"string","enum":["column"]},{"type":"string","enum":["size"]},{"type":"string","enum":["stage"]},{"type":"string","enum":["stages"]},{"type":"string","enum":["category"]},{"type":"string","enum":["region"]},{"type":"string","enum":["geography"]},{"type":"string","enum":["latitude"]},{"type":"string","enum":["longitude"]},{"type":"string","enum":["minimum"]},{"type":"string","enum":["maximum"]},{"type":"string","enum":["target"]}],"description":"The chart channel to move the column onto."}},"title":"Channel destination"},{"type":"object","required":["type","groupingId"],"properties":{"type":{"type":"string","enum":["grouping"]},"groupingId":{"type":"string","description":"The ID of the grouping (level) on a Table element to move the column into."}},"title":"Grouping destination"}],"description":"Where to move the column. The column already occupying this destination is moved to where `source` came from."},"source":{"type":"object","required":["type","columnId"],"properties":{"type":{"type":"string","enum":["column"]},"columnId":{"type":"string","description":"The ID of the column to move or swap."}},"description":"The column to swap."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["show-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to show, or a control whose selected values determine which columns to show."}}},{"type":"object","required":["type","source"],"properties":{"type":{"type":"string","enum":["hide-columns"]},"source":{"oneOf":[{"allOf":[{"type":"object","required":["type","columnIds"],"properties":{"type":{"type":"string","enum":["columns"]},"columnIds":{"type":"array","items":{"type":"string"},"description":"The column IDs to show or hide."}}},{"type":"object","properties":{"otherColumns":{"oneOf":[{"type":"string","enum":["unchanged"]},{"type":"string","enum":["opposite"]}],"description":"What happens to columns not named in `columnIds`: 'unchanged' (default), or 'opposite' to apply the opposite visibility to them."}}}],"title":"Static columns source"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string","description":"The driving control's public variableName. Must be the action's own trigger control -- the control whose change event runs this action."}}}],"description":"The columns to hide, or a control whose selected values determine which columns to hide."}}},{"allOf":[{"type":"object","required":["type","scale"],"properties":{"type":{"type":"string","enum":["set-axis-scale"]},"scale":{"type":"object","required":["type"],"properties":{"type":{"oneOf":[{"type":"string","enum":["linear"]},{"type":"string","enum":["log"]},{"type":"string","enum":["ordinal"]},{"type":"string","enum":["pow"]},{"type":"string","enum":["sqrt"]},{"type":"string","enum":["time"]}],"description":"The scale type of the axis."}},"description":"The scale to apply."}}},{"type":"object","properties":{"axis":{"oneOf":[{"type":"string","enum":["dimension"]},{"type":"string","enum":["value"]},{"type":"string","enum":["secondary-value"]}],"description":"Which axis to scale: the category/dimension axis, the primary measure axis (default), or the secondary measure axis (columns flagged onto it)."}}}]}],"description":"The modification to apply."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Shows, hides, moves, or swaps columns, or sets an axis scale, on a chart, pivot table, or Table element.","title":"Modify Element"},{"allOf":[{"type":"object","required":["effect","codeElementId"],"properties":{"effect":{"type":"string","enum":["run-python-element"]},"codeElementId":{"type":"string","description":"The code element to run."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Runs a code element.","title":"Run Python Element"},{"allOf":[{"type":"object","required":["effect","pluginElementId","pluginEffectId"],"properties":{"effect":{"type":"string","enum":["trigger-plugin"]},"pluginElementId":{"type":"string","description":"The plugin element whose action effect to trigger."},"pluginEffectId":{"type":"string","description":"The action effect ID registered by the plugin."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Triggers an action effect within a plugin element.","title":"Trigger Plugin"},{"allOf":[{"type":"object","required":["effect","eventName","payload"],"properties":{"effect":{"type":"string","enum":["send-embed-event"]},"eventName":{"type":"string","description":"The event name included in the posted message."},"payload":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"The key for this value in the posted message payload."},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["constant"]},"value":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text"]},"value":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"A text value, or null for empty."}},"description":"","title":"Text"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["number"]},"value":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"A number value, or null for empty."}},"description":"","title":"Number"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["boolean"]},"value":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"A boolean value, or null for empty."}},"description":"","title":"Boolean"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["date"]},"value":{"oneOf":[{"oneOf":[{"type":"string","description":"","title":"Fixed"},{"type":"object","required":["op","unit","value"],"properties":{"op":{"oneOf":[{"type":"string","enum":["now-minus"]},{"type":"string","enum":["now-plus"]}],"description":"Whether the relative date range is before or after the specified date."},"unit":{"oneOf":[{"type":"string","enum":["year"]},{"type":"string","enum":["quarter"]},{"type":"string","enum":["month"]},{"type":"string","enum":["week-starting-sunday"]},{"type":"string","enum":["week-starting-monday"]},{"type":"string","enum":["day"]},{"type":"string","enum":["hour"]},{"type":"string","enum":["minute"]}],"description":"The unit of time to filter on."},"value":{"type":"number","description":"The number of units to filter on, e.g., \"x units ago\" or \"in x units\"."}},"description":"","title":"Relative"}]},{"type":"null"}],"description":"A date value in ISO 8601 format (fixed or relative), or null for empty. E.g. `2017-08-26T05:21:34Z`."}},"description":"","title":"Date"}]}},"description":"A literal scalar value.","title":"Constant"},{"type":"object","required":["type","control"],"properties":{"type":{"type":"string","enum":["control"]},"control":{"type":"string"}},"description":"A copy of another control's current value, referenced by its control ID.","title":"Control"},{"type":"object","required":["type","formula"],"properties":{"type":{"type":"string","enum":["formula"]},"formula":{"type":"string"}},"description":"A formula expression. Can reference controls by control ID, other elements by name, or [Selection/col] for a select trigger.","title":"Formula"}],"description":"The value to include."}}},"description":"Key-value pairs included in the posted message payload, in order."}}},{"type":"object","properties":{"name":{"type":"string","description":"Name of the effect. A named effect’s return value can be referenced in later formulas when the effect produces one."}}}],"description":"Sends a message to the embedding parent page.","title":"Send Embed Event"}]},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for this step."}}}],"description":"An action effect to run. Effects that depend on user interaction, such as a selected row or column, are not supported.","title":"Inline effect"}]},"description":"The steps the agent runs when it invokes this action tool."}}},{"type":"object","properties":{"requiresApproval":{"type":"boolean","description":"Whether the agent must pause to get user approval before running this tool. Defaults to `false`."}}}],"description":"","title":"Action"}]},"description":"The tools the agent can invoke to take action or enrich insights."}}}]},"description":"The agents defined in the workbook. Reference one from a chat element using `agentId`."}}},{"type":"object","properties":{"automatedActions":{"type":"array","items":{"allOf":[{"type":"object","required":["effects","id","schedule","trigger"],"properties":{"effects":{"type":"array","items":{"allOf":[{"type":"object","required":["agentId","effect","prompt"],"properties":{"agentId":{"type":"string","description":"The identifier of the Sigma agent to run in this workbook."},"effect":{"type":"string","enum":["call-agent"]},"prompt":{"type":"string","description":"The instructions passed to the agent when the action runs."}}},{"type":"object","properties":{"actionVariables":{"type":"array","items":{"allOf":[{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"The identifier of the action variable for the agent to return the value from."},"type":{"oneOf":[{"type":"string","enum":["text"]},{"type":"string","enum":["number"]},{"type":"string","enum":["integer"]},{"type":"string","enum":["boolean"]},{"type":"string","enum":["datetime"]}],"description":"Scalar data type of the action variable."}}},{"type":"object","properties":{"name":{"type":"string","description":"Display name for the action variable."}}}]},"description":"The action variables populated from the agent response."}}}]},"description":"The actions that run when the schedule triggers."},"id":{"type":"string","description":"The stable identifier for this automated action sequence."},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"The cron expression that determines when the scheduled action runs. E.g., `0 9 * * 1` runs every Monday at 9:00 AM."},"timezone":{"type":"string","description":"The IANA timezone used to evaluate the cron expression."}},"description":"The configuration of a recurring schedule. Includes a cron expression and timezone."},"trigger":{"type":"string","enum":["schedule"],"description":"Runs the automated action sequence on a recurring schedule."}}},{"type":"object","properties":{"name":{"type":"string","description":"Optional display name for the automated action sequence."},"state":{"oneOf":[{"type":"string","enum":["enabled"]},{"type":"string","enum":["disabled"]}],"description":"Whether the automated action sequence is turned on or off."}}}]},"description":"The action sequences that run automatically on a schedule or webhook trigger."}}}]},{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["workbook"],"description":"Document kind. Always `workbook` for this resource."}}}]},{"type":"object","required":["layout"],"properties":{"layout":{"type":"string","description":"Grid layout as XML.","title":"Layout XML"}}}],"description":"The code representation of the workbook to write: its pages, elements, columns, sources, layout, and theme.","title":"Workbook Document"}}},{"type":"object","properties":{"description":{"type":"string","description":"The description of the workbook."}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["valid"],"properties":{"valid":{"type":"boolean","enum":[true],"description":"The workbook code representation passed validation."}},"description":"A valid workbook code representation."},{"type":"object","required":["valid","errors"],"properties":{"valid":{"type":"boolean","enum":[false],"description":"The workbook code representation failed validation."},"errors":{"type":"array","items":{"type":"object","required":["summary"],"properties":{"summary":{"type":"string","description":"A human-readable description of a validation failure."}}},"description":"The validation failures found in the code representation."}},"description":"An invalid workbook code representation, with the validation failures."}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workbooks/tag":{"post":{"summary":"Tag a workbook","description":"Add a version tag to a workbook and optionally set up a connection to swap to for a specific version of the workbook.\n\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Retrieve the **tag** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n  - Retrieve the **connectionId** to use as the **fromId** or **toId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n  - If your workbook includes a source that is not mapped to a new source, that source is not swapped.\n  - When swapping data models used as the source for the workbook:\n    - You can only swap a data model source to another version of the same data model source. You cannot swap a data model source to a table in your data warehouse or a dataset.\n    - When you swap sources from one data model version to a new one, specify the version tag of the data model that you swap to with `toVersionTagId`:\n      - To swap to the latest published version of the data model, specify `toVersionTagId` as `null`.\n      - To swap to a specific tagged version of the data model, specify the `toVersionTagId` of the data model.\n    - If the workbook already uses a specific tagged version of a data model as a source, use `fromVersionTagId` to indicate which tagged version to swap from.\n      - To swap from the latest published version of the data model, specify `fromVersionTagId` as `null`.\n      - To swap from a specific tagged version of the data model, specify the `fromVersionTagId` of the data model.\n  - To retrieve the `fromVersionTagId` for a data model used as the workbook source, call the [/v2/workbooks/{workbookId}/sources](https://help.sigmacomputing.com/reference/get-workbook-sources) endpoint and use the `versionTagId` in the response.\n  - To retrieve the `versionTagId` for a data model, call the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint and use the `versionTagId` in the response.\n\n  ### Usage scenarios\n  - **Lifecycle management**: Identify production and development resources.\n    ","parameters":[],"operationId":"tagWorkbook","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["workbookId","tag"],"properties":{"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"tag":{"type":"string","description":"Name of the version tag to apply.","title":"Version tag name"}}},{"type":"object","properties":{"workbookVersion":{"type":"number","description":"Specific version of the published workbook to tag."},"sourceMappingConfig":{"type":"array","items":{"type":"object","required":["fromConnectionId","toConnectionId","paths"],"properties":{"fromConnectionId":{"type":"string"},"toConnectionId":{"type":"string"},"paths":{"type":"array","items":{"type":"object","required":["fromPath","toPath"],"properties":{"fromPath":{"type":"array","items":{"type":"string"}},"toPath":{"type":"array","items":{"type":"string"}}}}}}},"description":"Swap sources for the workbook when you add a tag."},"dataModelSourceTaggedVersions":{"type":"array","items":{"type":"object","required":["dataModelId","fromVersionTagId","toVersionTagId"],"properties":{"dataModelId":{"type":"string"},"fromVersionTagId":{"type":["string","null"]},"toVersionTagId":{"type":["string","null"]}}},"description":"Which tagged version of the data model to use as the source."},"sourceVersions":{"type":"object","additionalProperties":{"type":"number"},"description":"Which version of source datasets to use."},"grantSourceAccess":{"type":"boolean","description":"Whether to grant users access to copied datasets if they create a copy via Save As."},"isDefault":{"type":"boolean","description":"Whether to make this tag the default tagged version to load if the user doesn't have access to the published version."}}}]},"examples":{"Request Example":{"value":{"workbookId":"12345678910","workbookVersion":4,"tag":"production","sourceMappingConfig":[{"fromConnectionId":"00000000-0000-0000-0000-000000000000","toConnectionId":"00000000-0000-0000-0000-000000000001","paths":[{"fromPath":["SNOWFLAKE_DEVELOPMENT","WEATHER","DAILY_14_TOTAL"],"toPath":["SNOWFLAKE_PRODUCTION","WEATHER","DAILY_16_TOTAL"]}]}],"sourceVersions":{"<datasetId>":2},"isDefault":true}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["versionTagId","taggedWorkbookId","taggedWorkbookVersion"],"properties":{"versionTagId":{"type":"string"},"taggedWorkbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"taggedWorkbookVersion":{"type":"number"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2/workspaces":{"get":{"summary":"List workspaces","description":"\n  **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request.\n\n  This endpoint returns a list of all workspaces. You can use pagination and optionally filter by name to manage large sets of data. See [Manage Workspaces](/docs/manage-workspaces) for more details about workspaces in Sigma.\n  ### Usage notes\n  - **Filtering by name**: Optionally, use the `name` parameter to filter workspaces by a case-insensitive substring match.\n  - **Filtering by exact name**: Optionally, use the `exactName` parameter to filter workspaces by an exact name match (also case-insensitive). When provided, `exactName` takes precedence over `name` and uses an indexed equality lookup, which is significantly faster than substring search.\n\n  ### Usage scenarios\n  - **Pagination**: Use the `page` and `limit` parameters to control the size and segment of the workspace list returned.\n  - **User interface display**: Populate a user interface with a list of all available workspaces, using pagination to efficiently load data and filtering to quickly find specific workspaces.\n  - **Administrative overview**: Provide system administrators with an overview of all workspaces for management and monitoring purposes, with the ability to browse through pages and search by name.\n\n  ### Best practices\n  - Use caching to reduce load times and server demand when frequently accessing workspace lists.\n  - Regularly update and synchronize workspace lists to ensure that displayed information is current and accurate.","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"name","schema":{"type":"string","description":"Filter workspaces by name (substring match, case-insensitive).","title":"Workspace Name Filter"},"in":"query"},{"name":"exactName","schema":{"type":"string","description":"Filter workspaces by exact name match (case-insensitive, like `name`). When set, this takes precedence over `name` and uses an indexed equality lookup instead of a substring search.","title":"Workspace Exact Name Filter"},"in":"query"}],"operationId":"listWorkspaces","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"object","required":["workspaceId","workspaceUrlId","name","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"workspaceId":{"type":"string"},"workspaceUrlId":{"type":"string","description":"Base62-encoded identifier used in Sigma workspace URLs.","title":"Workspace URL ID"},"name":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"title":"Workspace details"},"description":"","title":"Single page"},{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["workspaceId","workspaceUrlId","name","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"workspaceId":{"type":"string"},"workspaceUrlId":{"type":"string","description":"Base62-encoded identifier used in Sigma workspace URLs.","title":"Workspace URL ID"},"name":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"title":"Workspace details"}},"nextPage":{"type":["string","null"]}},"description":"","title":"Paginated results"}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workspaces"]},"post":{"summary":"Create a workspace","description":"This endpoint allows clients to create a workspace with specific characteristics.\n\n### Usage notes\n- Set **NoDuplicates** to **true** to prevent the creation of a workspace with a name that already exists.\n\n### Usage scenarios\n- **Initial setup**: Useful for users setting up a new workspace after signing up.\n- **Project separation**: Helps in creating separate workspaces for different projects or teams.\n\n### Best practices\n- **Check for existing names**: Before setting `noDuplicates` to true, make sure to search for existing workspace names to avoid conflicts.\n- **Consistent naming conventions**: Adopt a consistent naming convention for workspaces to ensure clarity and avoid confusion.","parameters":[],"operationId":"createWorkspace","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the new workspace.","title":"Workspace Name"}}},{"type":"object","properties":{"noDuplicates":{"type":"boolean","description":"Set to true to avoid creating a workspace with a duplicate name.","title":"No Duplicates Flag"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["workspaceId","workspaceUrlId","name","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"workspaceId":{"type":"string"},"workspaceUrlId":{"type":"string","description":"Base62-encoded identifier used in Sigma workspace URLs.","title":"Workspace URL ID"},"name":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"title":"Workspace details"},{"type":"object","required":["workspaceIds","workspaceUrlIds"],"properties":{"workspaceIds":{"type":"array","items":{"type":"string"}},"workspaceUrlIds":{"type":"array","items":{"type":"string"}}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workspaces"]}},"/v2/workspaces/{workspaceId}":{"get":{"summary":"Get a workspace","description":"This endpoint retrieves the details of a specific workspace by its workspaceId.\n\n### Usage notes\n- Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.\n\n### Usage scenarios\n- **Workspace management**: Useful for administrators or users who need to view the details of a specific workspace.\n- **Integration checks**: Can be used by external systems to verify the existence and status of a workspace as part of integration workflows.\n\n### Best practices\n- **Validate workspaceId**: Ensure the workspaceId provided is valid and corresponds to an existing workspace. Handle any errors gracefully.\n- **Access controls**: Implement proper authorization checks to ensure that only entitled users can access workspace details.","parameters":[{"name":"workspaceId","schema":{"type":"string","description":"Unique identifier of the workspace.","title":"Workspace ID"},"in":"path","required":true}],"operationId":"getWorkspace","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["workspaceId","workspaceUrlId","name","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"workspaceId":{"type":"string"},"workspaceUrlId":{"type":"string","description":"Base62-encoded identifier used in Sigma workspace URLs.","title":"Workspace URL ID"},"name":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"title":"Workspace details"}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workspaces"]},"patch":{"summary":"Update a workspace","description":"This endpoint updates the name of an existing workspace identified by its workspaceId.\n\n### Usage notes\n- Set `NoDuplicates` to `true` to prevent the creation of a duplicate workspace.\n- Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.\n\n### Usage scenarios\n- **Configuration change**: Allows users to update workspace settings or names as projects evolve or requirements change.\n- **Access control adjustments**: Update workspace details in response to organizational changes or policy updates.\n\n### Best practices\n- **Partial updates**: Use PATCH to support partial updates, only sending the fields that need to be updated.\n- **Validation**: Validate input data to ensure it adheres to expected formats and constraints. Handle errors gracefully and inform the user of any constraints.","parameters":[{"name":"workspaceId","schema":{"type":"string","description":"Unique identifier of the workspace.","title":"Workspace ID"},"in":"path","required":true}],"operationId":"updateWorkspace","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the new workspace.","title":"Workspace Name"}}},{"type":"object","properties":{"noDuplicates":{"type":"boolean","description":"Set to true to avoid creating a workspace with a duplicate name.","title":"No Duplicates Flag"}}}]}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["workspaceId","workspaceUrlId","name","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"workspaceId":{"type":"string"},"workspaceUrlId":{"type":"string","description":"Base62-encoded identifier used in Sigma workspace URLs.","title":"Workspace URL ID"},"name":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"title":"Workspace details"}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workspaces"]},"delete":{"summary":"Delete a workspace","description":"You can use this endpoint to delete an existing workspace by its workspaceId. **Caution:** Deleted workspaces cannot be recovered.\n\n### Usage notes\n- Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.\n\n### Usage scenarios\n- **Cleanup operations**: Useful for removing workspaces that are no longer needed or relevant.\n- **Resource management**: Helps in managing the overall resource allocation by removing unused workspaces.\n\n### Best practices\n- **Confirm before deletion**: Always ensure that deletion operations are preceded by explicit user confirmations to prevent accidental loss of data.\n- **Audit and logging**: Maintain audit logs for deletion actions to track who deleted the workspace and when.","parameters":[{"name":"workspaceId","schema":{"type":"string","description":"Unique identifier of the workspace.","title":"Workspace ID"},"in":"path","required":true}],"operationId":"deleteWorkspace","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workspaces"]}},"/v2/workspaces/{workspaceId}/grants":{"post":{"summary":"Grant permissions to the workspace for users or teams","description":"This endpoint allows creating a grant which specifies permissions for one or more users or teams to access a workspace.\n\n### Usage notes\n- **Grants**: An array of grant objects. Each object specifies a grantee and the permission level assigned to them.\n- Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.\n- Do not set both **memberId** and **teamId** in the same **grantee** object. Instead, choose one based on the target of the grant.\n\n  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n  - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n\n### Usage scenarios\n- **Access control setup**: Use this endpoint to set up or modify access controls for a workspace, specifying which users or teams can access and what actions they can perform.\n\n### Best practices\n- **Clear permission definitions**: Ensure that the permissions granted are well understood by both the grantor and the grantee to avoid misuse of access rights.","parameters":[{"name":"workspaceId","schema":{"type":"string","description":"Unique identifier of the workspace.","title":"Workspace ID"},"in":"path","required":true}],"operationId":"createWorkspaceGrant","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","items":{"type":"object","required":["grantee","permission"],"properties":{"grantee":{"oneOf":[{"type":"object","required":["memberId"],"properties":{"memberId":{"type":"string"}},"description":"The UUID of the member receiving the grant","title":"Member"},{"type":"object","required":["teamId"],"properties":{"teamId":{"type":"string"}},"description":"The UUID of the team receiving the grant","title":"Team"}]},"permission":{"type":"string","enum":["view","explore","organize","edit"],"description":"Defines the level of access that is granted. Each permission level allows different types of operations.","title":"Permission Level"}}}}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workspaces"]},"get":{"summary":"List grants for a workspace","description":"This endpoint retrieves a list of all permission grants associated with a specific workspace, identified by its workspaceId.\n\n### Usage notes\n- Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.\n- Optionally use the `page` and `limit` parameters to manage the size of the returned data and navigate through large sets of data.\n\n### Usage scenarios\n- **Access control management**: Useful for administrators to review and manage who has what access to the workspace.\n- **Audit and compliance**: Assists in compliance checks and audits by providing a clear view of the permissions granted to different users and teams.\n\n### Best practices\n- **Use pagination**: Especially important for workspaces with a large number of grants to ensure performance and usability.\n- **Regular review**: Regularly review and update the workspace grants to ensure they align with current organizational policies and user roles.","parameters":[{"name":"workspaceId","schema":{"type":"string","description":"Unique identifier of the workspace.","title":"Workspace ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"listWorkspaceGrants","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["grantId","inodeId","organizationId","memberId","teamId","permission","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"grantId":{"type":"string","description":"The unique identifier of the grant"},"inodeId":{"type":"string","description":"The unique identifier of the inode"},"organizationId":{"type":"string","description":"The unique identifier of the organization"},"memberId":{"type":["string","null"],"description":"The unique identifier of the member"},"teamId":{"type":["string","null"],"description":"The unique identifier of the team"},"permission":{"oneOf":[{"type":"string","enum":["admin","annotate","update","usage","writeback"],"description":"Valid inode types: table, connection database, and connection schema.","title":"Connection Permission"},{"type":"string","enum":["create","annotate","organize","explore","view","edit","apply"],"description":"Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as **organize** and Can Manage permissions are listed as **edit**.","title":"Inode Permission"},{"type":"string","enum":["view","edit","apply"],"description":"Valid inode types: version tag.","title":"Version Tag Permission"}],"description":"The permission granted to the member"},"createdBy":{"type":"string","description":"The identifier of the user who created this grant"},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this grant"},"createdAt":{"type":"string","format":"date-time","description":"When the grant was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the grant was last updated"}},"title":"Connection grant response"}},"nextPage":{"type":["string","null"]}}},{"type":"object","properties":{"total":{"type":"number"},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workspaces"]}},"/v2/workspaces/{workspaceId}/grants/{grantId}":{"delete":{"summary":"Delete a workspace grant","description":"Delete a specific grant of permissions granted on a workspace to a user or team.\n\n  ### Usage notes\n  - Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.\n  - Retrieve the **grantId** by calling the [/v2/workspaces/{workspaceId}/grants](https://help.sigmacomputing.com/reference/list-workspace-grants) endpoint.\n  ","parameters":[{"name":"workspaceId","schema":{"type":"string","description":"Unique identifier of the workspace.","title":"Workspace ID"},"in":"path","required":true},{"name":"grantId","schema":{"type":"string"},"in":"path","required":true}],"operationId":"deleteWorkspaceGrant","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workspaces"]}},"/v2.1/members":{"get":{"summary":"List members (Paginated)","description":"\n**Attention:** This API endpoint uses pagination by default.\n\nList all users in Sigma.\n\n### Usage notes\n- Filter your results using the `email` query parameter.\n- If using `email` to filter by email address, you must URL encode the \"@\" character as `%40`.\n","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"email","schema":{"type":"string","description":"Filter by email address. You must URL encode the \"@\" character as `%40`."},"in":"query"},{"name":"includeArchived","schema":{"type":"boolean"},"in":"query"},{"name":"includeInactive","schema":{"type":"boolean"},"in":"query"}],"operationId":"v2_1_listMembers","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["organizationId","memberId","memberType","firstName","lastName","email","profileImgUrl","createdBy","updatedBy","createdAt","updatedAt","homeFolderId","userKind"],"properties":{"organizationId":{"type":"string"},"memberId":{"type":"string"},"memberType":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"profileImgUrl":{"type":["string","null"]},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"homeFolderId":{"type":"string","description":"ID of the My Documents folder for the user"},"userKind":{"type":"string"}}},{"type":"object","properties":{"isArchived":{"type":"boolean","description":"Whether a user is deactivated in Sigma."},"isInactive":{"type":"boolean","description":"Whether a user is archived by SCIM."}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["members"]}},"/v2.1/teams":{"get":{"summary":"List teams (Paginated)","description":"\n  **Attention:** This API endpoint uses pagination by default.\n\n  List all teams in Sigma.\n  ","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"name","schema":{"type":"string"},"in":"query"},{"name":"description","schema":{"type":"string"},"in":"query"},{"name":"visibility","schema":{"type":"string","enum":["public","private"]},"in":"query"}],"operationId":"v2_1_listTeams","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["teamId","createdBy","updatedBy","createdAt","updatedAt","name","description","visibility"],"properties":{"teamId":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"description":{"type":["string","null"]},"visibility":{"type":["string","null"],"enum":["public","private"]}}},{"type":"object","properties":{"isArchived":{"type":"boolean"}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["teams"]}},"/v2.1/workbooks/{workbookId}/materialization-schedules":{"get":{"summary":"List materialization schedules for a workbook (Paginated)","description":"\n  **Attention:** This API endpoint uses pagination by default.\n\n  This endpoint retrieves a list of all materialization schedules associated with a workbook. Each schedule details when and how often specific workbook elements are automatically materialized to optimize performance and data freshness.\n  ### Usage notes\n  - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - To retrieve additional pages of results, use the response of the `nextPage` parameter as the `page` query parameter in the following request.\n\n  ### Usage scenarios\n  - **Monitoring and management:** Administrators can monitor and manage the schedules for materialization to ensure optimal system performance.\n  - **Audit and review:** Periodic reviews of materialization schedules can help in assessing the efficiency of data processes and making necessary adjustments.\n\n  ### Best practices\n  - Regularly review materialization schedules to align them with current data usage patterns and business needs.\n  - Use pagination to manage large sets of data and improve response times of API calls.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"v2_1_listMaterializationSchedules","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["sheetId","elementId","elementName","schedule","configuredAt","paused"],"properties":{"sheetId":{"type":"string","description":"Identifier of the materialization schedule for the element","title":"Sheet ID"},"elementId":{"type":"string","description":"Identifier of the element being materialized","title":"Element ID"},"elementName":{"type":"string"},"schedule":{"type":["object","null"],"properties":{"cronSpec":{"type":"string","description":"Cron expression to use for the schedule"},"timezone":{"type":"string","description":"Timezone code, for example, PST"}}},"configuredAt":{"type":"string","format":"date-time"},"paused":{"type":"boolean"}}},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2.1/workbooks/{workbookId}/schedules":{"get":{"summary":"List scheduled workbook exports (Paginated)","description":"\n  **Attention:** This API endpoint uses pagination by default.\n\n  This endpoint retrieves a list of all scheduled exports for a specified workbook. These schedules represent planned events that can trigger exports based on various conditions and timings.\n  ### Usage Notes\n  - The **workbookId** in the path parameter identifies the workbook whose scheduled exports are to be listed. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n  - Use pagination query parameters to manage the volume of data returned by this endpoint.\n\n  ### Usage Scenarios\n  - **Schedule Overview:** Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a workbook.\n  - **Audit and Compliance:** This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies.\n\n  ### Best Practices\n  - Implement client-side handling to manage paginated data effectively, especially in cases where a workbook has a large number of scheduled exports.\n  - Regularly audit schedules to keep them up-to-date and aligned with the current needs and workflows.","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true},{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"}],"operationId":"v2_1_listWorkbookSchedules","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["scheduledNotificationId","workbookId","schedule","configV2","isSuspended","ownerId","lastUpdatedByUser","disabledAt","disabledBy"],"properties":{"scheduledNotificationId":{"type":"string","description":"Unique identifier of the scheduled export.","title":"Schedule ID"},"workbookId":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"schedule":{"type":"object","required":["cronSpec","timezone"],"properties":{"cronSpec":{"type":"string","description":"A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`."},"timezone":{"type":"string","description":"An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`."}}},"configV2":{"allOf":[{"type":"object","required":["title","messageBody","notificationAttachments"],"properties":{"title":{"type":"string"},"messageBody":{"type":"string"},"notificationAttachments":{"type":"array","items":{"allOf":[{"type":"object","required":["formatOptions"],"properties":{"formatOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["CSV"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSON"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["JSONL"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["EXCEL"]}}},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PDF"]}}},{"type":"object","properties":{"layout":{"type":"string","enum":["portrait","landscape"]},"scaleFactor":{"type":"number"}}}]},{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["PNG"]}}},{"type":"object","properties":{"pixelWidth":{"type":["number","null"]},"pixelHeight":{"type":["number","null"]}}}]},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["NONE"]}}}]}}},{"type":"object","properties":{"chartId":{"type":"string"},"workbookExportSource":{"oneOf":[{"type":"object","required":["type","elementId"],"properties":{"type":{"type":"string","enum":["element"]},"elementId":{"type":"string"}},"description":"Export one element","title":"One element"},{"type":"object","required":["type","pageId"],"properties":{"type":{"type":"string","enum":["page"]},"pageId":{"type":"string"}},"description":"Export one page","title":"One page"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["element"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple elements","title":"Multiple elements"},{"type":"object","required":["type","nodeIds"],"properties":{"type":{"type":"string","enum":["page"]},"nodeIds":{"type":"array","items":{"type":"string"}}},"description":"Export multiple pages","title":"Multiple pages"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["all"]}},"description":"Export all pages and elements in a workbook","title":"Entire workbook"}]}}}]}}}},{"type":"object","properties":{"includeLink":{"type":"boolean"},"runAsRecipient":{"type":"boolean"},"attachmentSettings":{"type":"object","properties":{"mergePdfAttachments":{"type":"boolean"},"zipAttachments":{"type":"boolean"}}},"conditionOptions":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["always"]}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["workbook"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"sheetId":{"type":"string"}}},{"type":"object","required":["type","sheetId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"sheetId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","sheetId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["sheetColumn"]},"sheetId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["worksheet"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isEmpty"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]}}},{"allOf":[{"type":"object","required":["type","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["queryColumn"]},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}},{"type":"object","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["dashboard"]},"conditions":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isEmpty"]},"tileId":{"type":"string"}}},{"type":"object","required":["type","tileId"],"properties":{"type":{"type":"string","enum":["isNotEmpty"]},"tileId":{"type":"string"}}},{"allOf":[{"type":"object","required":["type","tileId","mode","columnId","op"],"properties":{"type":{"type":"string","enum":["chartColumn"]},"tileId":{"type":"string"},"mode":{"oneOf":[{"type":"string","enum":["any"]},{"type":"string","enum":["all"]}]},"columnId":{"type":"string"},"op":{"type":"string","enum":["Equals","GreaterThan","GreaterThanEq","LessThan","LessThanEq","NotEquals","IsNotNull","IsNull","Contains","StartsWith","EndsWith"]}}},{"type":"object","properties":{"value":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["null"]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["bool"]},"val":{"type":"boolean"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["number"]},"val":{"type":"number"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["integer"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["string"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["datetime"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["error"]},"val":{"type":"string"}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["record"]},"val":{"type":"object","additionalProperties":{}}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["array"]},"val":{"oneOf":[{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["boolArr"]},"data":{"type":"array","items":{"type":["boolean","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["numberArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bigintArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["stringArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["datetimeArr"]},"data":{"type":"array","items":{"type":["number","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["bytesArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}},{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","enum":["variantArr"]},"data":{"type":"array","items":{"type":["string","null"]}}}}]}}},{"type":"object","required":["type","val"],"properties":{"type":{"type":"string","enum":["variant"]},"val":{"type":"string"}}}],"type":"null"}}}]}]}}}}]},"alertConfig":{"allOf":[{"type":"object","required":["window"],"properties":{"window":{"type":"string","enum":["alltime","daily","weekly","always"]}}},{"type":"object","properties":{"volume":{"oneOf":[{"type":"number"},{"type":"null"}]}}}]},"notificationName":{"type":"string"},"dashboardSettings":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["id","filterStr"],"properties":{"id":{"type":"string"},"filterStr":{"type":"string"}}}},"variableValues":{"$ref":"#/components/schemas/DashVariables"}}},"dynamicExportSettings":{"type":"object","properties":{"variables":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-list"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-range"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["date-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["number-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text-null"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["boolean-null"]}}}],"type":"object"}}}},"dynamicRecipientSettings":{"type":"object","required":["sourceNodeId","recipientColumnId"],"properties":{"sourceNodeId":{"type":"string"},"recipientColumnId":{"type":"string"}}},"rowLimit":{"type":"number"},"workbookVariant":{"type":"object","properties":{"tagId":{"type":"string"},"exploreKey":{"type":"string"},"bookmarkId":{"type":"string"}}},"embedOpts":{"type":"object","properties":{"embedId":{"type":"string"},"evalConnectionId":{"type":"string"}}},"formatting":{"type":["object","null"],"properties":{"pivotHeaderStyle":{"type":["string","null"],"enum":["merged","repeated"]}}}}}]},"isSuspended":{"type":"boolean","description":"Whether the schedule is currently suspended."},"ownerId":{"type":"string","description":"Unique identifier of the user who owns the schedule.","title":"Owner ID"},"lastUpdatedByUser":{"type":"string","description":"Unique identifier of the user who last updated the schedule.","title":"Last Updated By"},"disabledAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the schedule was disabled, or null if the schedule is active.","title":"Disabled At"},"disabledBy":{"type":["string","null"],"description":"Unique identifier of the member who disabled the schedule, or null if the schedule is active.","title":"Disabled By"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}},"/v2.1/workspaces":{"get":{"summary":"List workspaces (Paginated)","description":"\n  **Attention:** This API endpoint uses pagination by default.\n\n  This endpoint returns all workspaces. See [Manage Workspaces](/docs/manage-workspaces) for more details about workspaces in Sigma.\n\n  ### Usage notes\n  - **Pagination**: Use the `page` and `limit` parameters to control the size and segment of the workspace list returned.\n  - **Filtering by name**: Optionally, use the `name` parameter to filter workspaces by a case-insensitive substring match.\n  - **Filtering by exact name**: Optionally, use the `exactName` parameter to filter workspaces by an exact name match (also case-insensitive). When provided, `exactName` takes precedence over `name` and uses an indexed equality lookup, which is significantly faster than substring search.\n\n  ### Usage scenarios\n  - **User interface display**: Populate a user interface with a list of all available workspaces, using pagination to efficiently load data and filtering to quickly find specific workspaces.\n  - **Administrative overview**: Provide system administrators with an overview of all workspaces for management and monitoring purposes, with the ability to browse through pages and search by name.\n\n  ### Best practices\n  - Use caching to reduce load times and server demand when frequently accessing workspace lists.\n  - Regularly update and synchronize workspace lists to ensure that displayed information is current and accurate.\n","parameters":[{"name":"page","schema":{"type":"string","description":"Use to specify further pages using the string returned in the nextPage portion of the response.","title":"Page"},"in":"query"},{"name":"limit","schema":{"type":"number","description":"Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results.","title":"Limit"},"in":"query"},{"name":"name","schema":{"type":"string","description":"Filter workspaces by name (substring match, case-insensitive).","title":"Workspace Name Filter"},"in":"query"},{"name":"exactName","schema":{"type":"string","description":"Filter workspaces by exact name match (case-insensitive, like `name`). When set, this takes precedence over `name` and uses an indexed equality lookup instead of a substring search.","title":"Workspace Exact Name Filter"},"in":"query"}],"operationId":"v2_1_listWorkspaces","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries","nextPage"],"properties":{"entries":{"type":"array","items":{"type":"object","required":["workspaceId","workspaceUrlId","name","createdBy","updatedBy","createdAt","updatedAt"],"properties":{"workspaceId":{"type":"string"},"workspaceUrlId":{"type":"string","description":"Base62-encoded identifier used in Sigma workspace URLs.","title":"Workspace URL ID"},"name":{"type":"string"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"title":"Workspace details"},"description":"Array of results returned by the endpoint"},"nextPage":{"type":["string","null"],"description":"Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`."}}},{"type":"object","properties":{"total":{"type":"number","description":"Total number of results. Useful to determine if there is a need to paginate."},"hasMore":{"type":"boolean","description":"**[Deprecated]** Indicates whether more results are available."}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workspaces"]}},"/v3alpha/allowedIps":{"get":{"summary":"List IP allowlist entries (Beta)","description":"Retrieve a paginated list of all IP addresses and CIDR ranges in your organization's IP allowlist.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Returns the IP allowlist entries.\n  - Results are sorted by creation date in descending order (newest first).\n  ","parameters":[{"name":"pageToken","schema":{"type":"string","description":"Use to specify the next set of results with the string returned in the `nextPageToken` field of the previous response.","title":"Page token"},"in":"query"},{"name":"pageSize","schema":{"type":"integer","description":"Number of results to return per page, with a maximum of 1000. Defaults to 50.","title":"Page size"},"in":"query"}],"operationId":"v3alpha_listIpAllowlistEntries","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["ipAllowlistEntryId","ip","scope"],"properties":{"ipAllowlistEntryId":{"type":"string","description":"Unique ID for this IP allowlist entry"},"ip":{"type":"string","description":"IPv4/IPv6 address or CIDR range"},"scope":{"type":"string","enum":["public-api","ui","both"],"description":"Scope for which this IP allowlist entry applies"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description for this IP allowlist entry"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"description":"Array of results returned by the endpoint","title":"Result entries"}}},{"type":"object","properties":{"nextPageToken":{"type":"string","description":"A string that can be passed to the `pageToken` parameter in the next request to fetch the next page of results. Not present in the last page of results.\n**Must be treated as an opaque string.**","title":"Next page token"}}}]}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["allowedIps"]}},"/v3alpha/allowedIps:batchCreate":{"post":{"summary":"Create IP allowlist entries (Beta)","description":"Add new IP address entries to your organization's IP allowlist.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Supports IPv4, IPv6, and CIDR ranges (e.g., `192.168.1.0/24`, `2001:db8::/32`).\n  - Maximum of 200 total IP entries allowed per organization.\n  - Duplicate IP addresses are not allowed. If a request contains an IP address already on the list, the request fails.\n\n  ### Usage scenarios\n  - Add IP ranges for new locations or employees.\n  - Bulk import IP addresses from a list.\n  ","parameters":[],"operationId":"v3alpha_createIpAllowlistEntries","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["ip","scope"],"properties":{"ip":{"type":"string","description":"IPv4/IPv6 address or CIDR range"},"scope":{"type":"string","enum":["public-api","ui","both"]}}},{"type":"object","properties":{"description":{"type":"string","description":"Description for this IP allowlist entry (max 255 characters)"}}}]},"description":"Array of IP allowlist entries to add (max 200 per organization)"}}}}}},"responses":{"201":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"allOf":[{"type":"object","required":["ipAllowlistEntryId","ip","scope"],"properties":{"ipAllowlistEntryId":{"type":"string","description":"Unique ID for this IP allowlist entry"},"ip":{"type":"string","description":"IPv4/IPv6 address or CIDR range"},"scope":{"type":"string","enum":["public-api","ui","both"],"description":"Scope for which this IP allowlist entry applies"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description for this IP allowlist entry"}}},{"type":"object","required":["createdBy","updatedBy","createdAt","updatedAt"],"properties":{"createdBy":{"type":"string","description":"The identifier of the user who created this object."},"updatedBy":{"type":"string","description":"The identifier of the user or process that last updated this object."},"createdAt":{"type":"string","format":"date-time","description":"When the object was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the object was last updated."}}}]},"description":"Array of created IP allowlist entries"}}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["allowedIps\\:batchCreate"]}},"/v3alpha/allowedIps:batchDelete":{"post":{"summary":"Delete IP allowlist entries (Beta)","description":"Remove existing IP address entries from your organization's IP allowlist.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n  ### Usage notes\n  - Retrieve the `ipAllowlistEntryId` values with the [/v3alpha/allowedIps](v3alpha_listipallowlistentries) endpoint or from the response of the [/v3alpha/allowedIps:batchCreate](v3alpha_createipallowlistentries) endpoint.\n  - Entries are identified by their unique IDs, not by IP addresses.\n\n  ### Usage scenarios\n  - Remove compromised or outdated IP addresses from access.\n  - Clean up unused IP allowlist entries.\n  ","parameters":[],"operationId":"v3alpha_deleteIpAllowlistEntries","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["ipAllowlistEntryIds"],"properties":{"ipAllowlistEntryIds":{"type":"array","items":{"type":"string"},"description":"Array of IP allowlist entry IDs to remove"}}}}}},"responses":{"204":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["allowedIps\\:batchDelete"]}},"/v3alpha/connections":{"post":{"summary":"Create a connection (Beta)","description":"Create a connection to a cloud data warehouse from Sigma. For additional details, see [Connect to data sources](https://help.sigmacomputing.com/docs/connect-to-data-sources).\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage Notes\n- Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.","parameters":[],"operationId":"v3alpha_createConnection","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["name","details"],"properties":{"name":{"type":"string","title":"Connection name"},"details":{"oneOf":[{"allOf":[{"type":"object","required":["type","serverHostname","httpPath","authentication"],"properties":{"type":{"type":"string","enum":["databricks"],"description":"Type of connection"},"serverHostname":{"type":"string","description":"Hostname of the Databricks compute resource"},"httpPath":{"type":"string","description":"HTTP path to connect to the Databricks SQL warehouse or cluster"},"authentication":{"oneOf":[{"type":"object","required":["type","serviceAccount"],"properties":{"type":{"type":"string","enum":["service-account"],"description":"Type of authentication"},"serviceAccount":{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Basic auth"},{"type":"object","required":["accessToken"],"properties":{"accessToken":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"title":"Access token"}}}],"description":"Connect to Databricks using a service account.","title":"Service account"}},"title":"Service account"},{"allOf":[{"type":"object","required":["type","userCredential"],"properties":{"type":{"type":"string","enum":["oauth"],"description":"Type of authentication"},"userCredential":{"type":"object","required":["oauthConfig"],"properties":{"oauthConfig":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["organization"],"description":"Type of OAuth"}},"title":"Organization-level OAuth"},{"allOf":[{"type":"object","required":["type","scopes","metadataUri","clientId"],"properties":{"type":{"type":"string","enum":["connection"],"description":"Type of OAuth"},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope.","title":"OAuth scopes"},"metadataUri":{"type":"string","description":"Metadata URI for your OAuth authorization server","title":"Metadata URI"},"clientId":{"type":"string","title":"Client ID"}},"title":"Connection-level OAuth configuration"},{"type":"object","required":["usePkce","assertionMethod"],"properties":{"usePkce":{"type":"boolean","description":"PKCE-enhanced authorization is required for Databricks OAuth.","title":"Use PKCE"},"assertionMethod":{"oneOf":[{"type":"object","required":["useJwt"],"properties":{"useJwt":{"type":"boolean","enum":[true]}},"title":"Use JWT Bearer Tokens"},{"type":"object","required":["useJwt","clientSecret"],"properties":{"useJwt":{"type":"boolean","enum":[false]},"clientSecret":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Client secret for your OAuth application."}},"title":"Use Client Secret"}]}}}],"title":"Connection-level OAuth"}],"description":"Choose whether to use the same OAuth configuration as the rest of your\n      Sigma organization or configure OAuth specifically for this connection.","title":"OAuth configuration"}},"description":"Connect to Databricks using OAuth.","title":"OAuth"}}},{"type":"object","properties":{"serviceAccount":{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Basic auth"},{"type":"object","required":["accessToken"],"properties":{"accessToken":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"title":"Access token"}}}],"description":"Connect to Databricks using a service account.","title":"Service account"}}}],"title":"OAuth"}],"description":"Choose whether to use a service account or OAuth to authenticate to Databricks."}}},{"type":"object","properties":{"writeAccess":{"allOf":[{"type":"object","required":["writeDestinations"],"properties":{"writeDestinations":{"type":"array","items":{"allOf":[{"type":"object","required":["destination"],"properties":{"destination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"title":"Destination"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the write destination"}}}],"title":"Write destination"},"description":"List of destinations where data can be written","title":"Write destinations"}}},{"type":"object","properties":{"inputTableAuditLogDestination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"description":"Audit log destination"}}}],"description":"Features like CSV upload, materialization, input tables, warehouse views, and\n  running Python code require write access to a destination in your warehouse.","title":"Write access"},"settings":{"allOf":[{"type":"object","properties":{"connectionTimeoutSecs":{"type":"number","description":"Number of seconds Sigma waits for a query to return results before timing out.","title":"Connection timeout"},"connectionQueueSize":{"type":"number","description":"Number of queries that Sigma can concurrently run on this connection.","title":"Connection queue size"},"useFriendlyNames":{"type":"boolean","description":"Whether to change the column names to be more readable. For example, a column \"SALES_JSON\" becomes \"Sales Json\". Defaults to true.","title":"Use friendly names"}},"description":"Configure specific settings for your connection.","title":"Settings"},{"type":"object","properties":{"enableHiveMetastore":{"type":"boolean","description":"To see and use your Hive metastore in Sigma, set to true.","title":"Enable Hive Metastore"}}}],"description":"Configure specific settings for your connection","title":"Settings"},"python":{"type":"object","required":["computeClusterId"],"properties":{"computeClusterId":{"type":"string","description":"Compute cluster ID to run Python queries","title":"Compute cluster ID"}},"description":"Allow users to access data on this connection using Python.","title":"Python configuration"},"sourceSwap":{"type":"object","required":["sourceSwapPolicyId"],"properties":{"sourceSwapPolicyId":{"type":"string","description":"Unique identifier of the source swap policy","title":"Source swap policy ID"}},"description":"Specify a policy to use for dynamically swapping data sources.","title":"Source swap policy"}}}],"title":"Databricks"},{"allOf":[{"type":"object","required":["type","accountName","host","authentication"],"properties":{"type":{"type":"string","enum":["snowflake"],"description":"Type of connection"},"accountName":{"type":"string","description":"Snowflake account name"},"host":{"type":"string","description":"Snowflake host"},"authentication":{"oneOf":[{"type":"object","required":["type","serviceAccount","userCredential"],"properties":{"type":{"type":"string","enum":["service-account"],"description":"Type of authentication"},"serviceAccount":{"oneOf":[{"allOf":[{"type":"object","required":["type","username"],"properties":{"type":{"type":"string","enum":["key-pair"],"description":"Type of authentication"},"username":{"type":"string","description":"Snowflake user name"}},"title":"Key pair"},{"type":"object","required":["privateKey"],"properties":{"privateKey":{"type":"string","description":"Private key in PEM format"}}},{"type":"object","properties":{"privateKeyPassphrase":{"type":"string","description":"Provide a passphrase if your private key is encrypted."}}}],"title":"Key pair"},{"allOf":[{"type":"object","required":["type","username"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"},"username":{"type":"string","description":"Snowflake user name"}},"title":"Basic auth"},{"type":"object","required":["password"],"properties":{"password":{"type":"string","description":"Password"}}}],"title":"Basic auth"}],"title":"Service account"},"userCredential":{"allOf":[{"type":"object","required":["warehouse"],"properties":{"warehouse":{"oneOf":[{"type":"object","required":["type","warehouse"],"properties":{"type":{"type":"string","enum":["static"],"description":"Type of warehouse"},"warehouse":{"type":"string","description":"Warehouse"}},"title":"Static warehouse"},{"type":"object","required":["type","userAttributeId"],"properties":{"type":{"type":"string","enum":["user-attribute"],"description":"Type of warehouse"},"userAttributeId":{"type":"string","description":"User attribute ID"}},"title":"User attribute warehouse"}],"title":"Warehouse"}}},{"type":"object","properties":{"role":{"oneOf":[{"type":"object","required":["type","role"],"properties":{"type":{"type":"string","enum":["static"],"description":"Type of role"},"role":{"type":"string"}},"description":"If no role is provided, the service account assumes the default role as configured in Snowflake.","title":"Static role"},{"type":"object","required":["type","userAttributeId"],"properties":{"type":{"type":"string","enum":["user-attribute"],"description":"Type of role"},"userAttributeId":{"type":"string"}},"title":"User attribute role"}],"title":"Role"}}}],"title":"User credential"}},"title":"Service account"},{"allOf":[{"type":"object","required":["type","userCredential"],"properties":{"type":{"type":"string","enum":["oauth"],"description":"Type of authentication"},"userCredential":{"type":"object","required":["oauthConfig"],"properties":{"oauthConfig":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["organization"],"description":"Type of OAuth"}},"title":"Organization-level OAuth"},{"allOf":[{"type":"object","required":["type","scopes","metadataUri","clientId"],"properties":{"type":{"type":"string","enum":["connection"],"description":"Type of OAuth"},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope.","title":"OAuth scopes"},"metadataUri":{"type":"string","description":"Metadata URI for your OAuth authorization server","title":"Metadata URI"},"clientId":{"type":"string","title":"Client ID"}},"title":"Connection-level OAuth configuration"},{"type":"object","required":["usePkce","assertionMethod"],"properties":{"usePkce":{"type":"boolean","description":"Whether to use PKCE-enhanced authorization."},"assertionMethod":{"oneOf":[{"type":"object","required":["type","clientSecret"],"properties":{"type":{"type":"string","enum":["client-secret"],"description":"Type of assertion method"},"clientSecret":{"type":"string","description":"Client secret for your OAuth application."}},"title":"Use client secret"},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["jwt-bearer"],"description":"Type of assertion method"}},"title":"Use JWT bearer tokens"}]}}}],"title":"Connection-level OAuth"}],"description":"Choose whether to use the same OAuth configuration as the rest of your\n      Sigma organization or configure OAuth specifically for this connection.","title":"OAuth configuration"}},"description":"Connect to Snowflake using OAuth.","title":"OAuth"}}},{"type":"object","properties":{"serviceAccount":{"allOf":[{"oneOf":[{"allOf":[{"type":"object","required":["type","username"],"properties":{"type":{"type":"string","enum":["key-pair"],"description":"Type of authentication"},"username":{"type":"string","description":"Snowflake user name"}},"title":"Key pair"},{"type":"object","required":["privateKey"],"properties":{"privateKey":{"type":"string","description":"Private key in PEM format"}}},{"type":"object","properties":{"privateKeyPassphrase":{"type":"string","description":"Provide a passphrase if your private key is encrypted."}}}],"title":"Key pair"},{"allOf":[{"type":"object","required":["type","username"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"},"username":{"type":"string","description":"Snowflake user name"}},"title":"Basic auth"},{"type":"object","required":["password"],"properties":{"password":{"type":"string","description":"Password"}}}],"title":"Basic auth"}],"title":"Service account"},{"type":"object","required":["role","warehouse"],"properties":{"role":{"type":"object","required":["type","role"],"properties":{"type":{"type":"string","enum":["static"],"description":"Type of role"},"role":{"type":"string"}},"description":"If no role is provided, the service account assumes the default role as configured in Snowflake.","title":"Static role"},"warehouse":{"type":"object","required":["type","warehouse"],"properties":{"type":{"type":"string","enum":["static"],"description":"Type of warehouse"},"warehouse":{"type":"string","description":"Warehouse"}},"title":"Static warehouse"}}}],"description":"Configure a service account to use alongside OAuth."}}}],"title":"OAuth"}],"description":"Choose whether to use key-pair, OAuth, or basic authentication to authenticate to Snowflake."}}},{"type":"object","properties":{"writeAccess":{"allOf":[{"type":"object","required":["writeDestinations"],"properties":{"writeDestinations":{"type":"array","items":{"allOf":[{"type":"object","required":["destination"],"properties":{"destination":{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database name"},"schema":{"type":"string","description":"Schema name"}},"title":"Destination"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the write destination"}}}],"title":"Write destination"},"description":"List of destinations where data can be written","title":"Write destinations"}}},{"type":"object","properties":{"inputTableAuditLogDestination":{"type":"object","required":["database","schema"],"properties":{"database":{"type":"string","description":"Database name"},"schema":{"type":"string","description":"Schema name"}},"description":"The schema where input table edits are logged. After being set, this cannot be changed without breaking write behavior on this connection.","title":"Input table audit log destination"},"materializationWarehouse":{"type":"string","description":"Specify a separate warehouse for materialization queries. If unset, Sigma uses the primary warehouse for this connection."},"useDynamicTables":{"type":"boolean","description":"Enable incremental materialization for improved performance and cost efficiency. If dynamic tables cannot be used (e.g. lack of permission), Sigma will do a full table refresh."}}}],"description":"Features like CSV upload, materialization, input tables, warehouse views, and running Python code require write access to a destination in your warehouse.","title":"Write access"},"settings":{"allOf":[{"type":"object","properties":{"connectionTimeoutSecs":{"type":"number","description":"Number of seconds Sigma waits for a query to return results before timing out.","title":"Connection timeout"},"connectionQueueSize":{"type":"number","description":"Number of queries that Sigma can concurrently run on this connection.","title":"Connection queue size"},"useFriendlyNames":{"type":"boolean","description":"Whether to change the column names to be more readable. For example, a column \"SALES_JSON\" becomes \"Sales Json\". Defaults to true.","title":"Use friendly names"}},"description":"Configure specific settings for your connection.","title":"Settings"},{"type":"object","properties":{"exportWarehouse":{"type":"string","description":"Specify a separate warehouse for all export queries. If unset, Sigma uses the primary warehouse for this connection."}}}]},"sourceSwap":{"type":"object","required":["sourceSwapPolicyId"],"properties":{"sourceSwapPolicyId":{"type":"string","description":"Unique identifier of the source swap policy","title":"Source swap policy ID"}},"description":"Specify a policy to use for dynamically swapping data sources.","title":"Source swap policy"}}}],"title":"Snowflake (NYI)"}],"title":"Connection details"}},"title":"Connection"}}}},"responses":{"201":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["connectionId","name","details"],"properties":{"connectionId":{"type":"string","description":"Unique identifier of the connection","title":"Connection ID"},"name":{"type":"string","title":"Connection name"},"details":{"allOf":[{"type":"object","required":["type","serverHostname","httpPath","authentication"],"properties":{"type":{"type":"string","enum":["databricks"],"description":"Type of connection"},"serverHostname":{"type":"string","description":"Hostname of the Databricks compute resource"},"httpPath":{"type":"string","description":"HTTP path to connect to the Databricks SQL warehouse or cluster"},"authentication":{"oneOf":[{"type":"object","required":["type","serviceAccount"],"properties":{"type":{"type":"string","enum":["service-account"],"description":"Type of authentication"},"serviceAccount":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Service account"}},"title":"Service account"},{"allOf":[{"type":"object","required":["type","userCredential"],"properties":{"type":{"type":"string","enum":["oauth"],"description":"Type of authentication"},"userCredential":{"type":"object","required":["oauthConfig"],"properties":{"oauthConfig":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["organization"],"description":"Type of OAuth"}},"title":"Organization-level OAuth"},{"allOf":[{"type":"object","required":["type","scopes","metadataUri","clientId"],"properties":{"type":{"type":"string","enum":["connection"],"description":"Type of OAuth"},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope.","title":"OAuth scopes"},"metadataUri":{"type":"string","description":"Metadata URI for your OAuth authorization server","title":"Metadata URI"},"clientId":{"type":"string","title":"Client ID"}},"title":"Connection-level OAuth configuration"},{"type":"object","required":["usePkce","useJwt"],"properties":{"usePkce":{"type":"boolean","description":"PKCE-enhanced authorization is required for Databricks OAuth.","title":"Use PKCE"},"useJwt":{"type":"boolean","title":"Use JWT"}}}],"title":"Connection-level OAuth"}],"description":"Choose whether to use the same OAuth configuration as the rest of your\n      Sigma organization or configure OAuth specifically for this connection.","title":"OAuth configuration"}},"title":"OAuth"}}},{"type":"object","properties":{"serviceAccount":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Service account"}}}],"title":"OAuth"}],"title":"Authentication"}}},{"type":"object","properties":{"writeAccess":{"allOf":[{"type":"object","required":["writeDestinations"],"properties":{"writeDestinations":{"type":"array","items":{"allOf":[{"type":"object","required":["destination"],"properties":{"destination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"title":"Destination"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the write destination"}}}],"title":"Write destination"},"description":"List of destinations where data can be written","title":"Write destinations"}}},{"type":"object","properties":{"inputTableAuditLogDestination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"description":"Audit log destination"}}}],"description":"Features like CSV upload, materialization, input tables, warehouse views, and\n  running Python code require write access to a destination in your warehouse.","title":"Write access"},"settings":{"allOf":[{"type":"object","properties":{"connectionTimeoutSecs":{"type":"number","description":"Number of seconds Sigma waits for a query to return results before timing out.","title":"Connection timeout"},"connectionQueueSize":{"type":"number","description":"Number of queries that Sigma can concurrently run on this connection.","title":"Connection queue size"},"useFriendlyNames":{"type":"boolean","description":"Whether to change the column names to be more readable. For example, a column \"SALES_JSON\" becomes \"Sales Json\". Defaults to true.","title":"Use friendly names"}},"description":"Configure specific settings for your connection.","title":"Settings"},{"type":"object","properties":{"enableHiveMetastore":{"type":"boolean","description":"To see and use your Hive metastore in Sigma, set to true.","title":"Enable Hive Metastore"}}}],"description":"Configure specific settings for your connection","title":"Settings"},"python":{"type":"object","required":["computeClusterId"],"properties":{"computeClusterId":{"type":"string","description":"Compute cluster ID to run Python queries","title":"Compute cluster ID"}},"description":"Allow users to access data on this connection using Python.","title":"Python configuration"},"sourceSwap":{"type":"object","required":["sourceSwapPolicyId"],"properties":{"sourceSwapPolicyId":{"type":"string","description":"Unique identifier of the source swap policy","title":"Source swap policy ID"}},"description":"Specify a policy to use for dynamically swapping data sources.","title":"Source swap policy"}}}],"title":"Connection details"}},"title":"Connection"}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v3alpha/connections/{connectionId}":{"patch":{"summary":"Update a connection (Beta)","description":"Update a connection to a cloud data warehouse from Sigma. Only the options specified in your request are updated. Other options remain the same.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n\n### Usage scenarios\n- Remove an optional parameter by setting it to `null`. If the field has a default value, the field resets to the default.\n- Update a field value by providing a new value.\n- Leave a field unchanged by omitting it from the request.\n","parameters":[{"name":"connectionId","schema":{"type":"string","description":"Unique identifier of the connection","title":"Connection ID"},"in":"path","required":true}],"operationId":"v3alpha_patchConnection","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","title":"Connection name"},"details":{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["databricks"],"description":"Type of connection"}}},{"type":"object","properties":{"serverHostname":{"type":"string","description":"Hostname of the Databricks compute resource"},"httpPath":{"type":"string","description":"HTTP path to connect to the Databricks SQL warehouse or cluster"},"authentication":{"oneOf":[{"type":"object","required":["type","serviceAccount"],"properties":{"type":{"type":"string","enum":["service-account"],"description":"Type of authentication"},"serviceAccount":{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Basic auth"},{"type":"object","required":["accessToken"],"properties":{"accessToken":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"title":"Access token"}}}],"description":"Connect to Databricks using a service account.","title":"Service account"}},"title":"Service account"},{"allOf":[{"type":"object","required":["type","userCredential"],"properties":{"type":{"type":"string","enum":["oauth"],"description":"Type of authentication"},"userCredential":{"type":"object","required":["oauthConfig"],"properties":{"oauthConfig":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["organization"],"description":"Type of OAuth"}},"title":"Organization-level OAuth"},{"allOf":[{"type":"object","required":["type","scopes","metadataUri","clientId"],"properties":{"type":{"type":"string","enum":["connection"],"description":"Type of OAuth"},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope.","title":"OAuth scopes"},"metadataUri":{"type":"string","description":"Metadata URI for your OAuth authorization server","title":"Metadata URI"},"clientId":{"type":"string","title":"Client ID"}},"title":"Connection-level OAuth configuration"},{"type":"object","required":["usePkce","assertionMethod"],"properties":{"usePkce":{"type":"boolean","description":"PKCE-enhanced authorization is required for Databricks OAuth.","title":"Use PKCE"},"assertionMethod":{"oneOf":[{"type":"object","required":["useJwt"],"properties":{"useJwt":{"type":"boolean","enum":[true]}},"title":"Use JWT Bearer Tokens"},{"type":"object","required":["useJwt","clientSecret"],"properties":{"useJwt":{"type":"boolean","enum":[false]},"clientSecret":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"description":"Client secret for your OAuth application."}},"title":"Use Client Secret"}]}}}],"title":"Connection-level OAuth"}],"description":"Choose whether to use the same OAuth configuration as the rest of your\n      Sigma organization or configure OAuth specifically for this connection.","title":"OAuth configuration"}},"description":"Connect to Databricks using OAuth.","title":"OAuth"}}},{"type":"object","properties":{"serviceAccount":{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Basic auth"},{"type":"object","required":["accessToken"],"properties":{"accessToken":{"oneOf":[{"type":"string"},{"type":"object","required":["secretManagerId","secretId"],"properties":{"secretManagerId":{"type":"string"},"secretId":{"type":"string"}}}],"title":"Access token"}}}],"description":"Connect to Databricks using a service account.","title":"Service account","type":"null"}}}],"title":"OAuth"}],"description":"Choose whether to use a service account or OAuth to authenticate to Databricks."},"writeAccess":{"allOf":[{"type":"object","required":["writeDestinations"],"properties":{"writeDestinations":{"type":"array","items":{"allOf":[{"type":"object","required":["destination"],"properties":{"destination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"title":"Destination"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the write destination"}}}],"title":"Write destination"},"description":"List of destinations where data can be written","title":"Write destinations"}}},{"type":"object","properties":{"inputTableAuditLogDestination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"description":"Audit log destination"}}}],"description":"Features like CSV upload, materialization, input tables, warehouse views, and\n  running Python code require write access to a destination in your warehouse.","title":"Write access","type":"null"},"settings":{"allOf":[{"type":"object","properties":{"connectionTimeoutSecs":{"type":"number","description":"Number of seconds Sigma waits for a query to return results before timing out.","title":"Connection timeout"},"connectionQueueSize":{"type":"number","description":"Number of queries that Sigma can concurrently run on this connection.","title":"Connection queue size"},"useFriendlyNames":{"type":"boolean","description":"Whether to change the column names to be more readable. For example, a column \"SALES_JSON\" becomes \"Sales Json\". Defaults to true.","title":"Use friendly names"}},"description":"Configure specific settings for your connection.","title":"Settings"},{"type":"object","properties":{"enableHiveMetastore":{"type":"boolean","description":"To see and use your Hive metastore in Sigma, set to true.","title":"Enable Hive Metastore"}}}],"description":"Configure specific settings for your connection","title":"Settings","type":"null"},"python":{"type":["object","null"],"required":["computeClusterId"],"properties":{"computeClusterId":{"type":"string","description":"Compute cluster ID to run Python queries","title":"Compute cluster ID"}},"description":"Allow users to access data on this connection using Python.","title":"Python configuration"},"sourceSwap":{"type":["object","null"],"required":["sourceSwapPolicyId"],"properties":{"sourceSwapPolicyId":{"type":"string","description":"Unique identifier of the source swap policy","title":"Source swap policy ID"}},"description":"Specify a policy to use for dynamically swapping data sources.","title":"Source swap policy"}}}],"title":"Connection details"}},"title":"Connection"}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["connectionId","name","details"],"properties":{"connectionId":{"type":"string","description":"Unique identifier of the connection","title":"Connection ID"},"name":{"type":"string","title":"Connection name"},"details":{"allOf":[{"type":"object","required":["type","serverHostname","httpPath","authentication"],"properties":{"type":{"type":"string","enum":["databricks"],"description":"Type of connection"},"serverHostname":{"type":"string","description":"Hostname of the Databricks compute resource"},"httpPath":{"type":"string","description":"HTTP path to connect to the Databricks SQL warehouse or cluster"},"authentication":{"oneOf":[{"type":"object","required":["type","serviceAccount"],"properties":{"type":{"type":"string","enum":["service-account"],"description":"Type of authentication"},"serviceAccount":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Service account"}},"title":"Service account"},{"allOf":[{"type":"object","required":["type","userCredential"],"properties":{"type":{"type":"string","enum":["oauth"],"description":"Type of authentication"},"userCredential":{"type":"object","required":["oauthConfig"],"properties":{"oauthConfig":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["organization"],"description":"Type of OAuth"}},"title":"Organization-level OAuth"},{"allOf":[{"type":"object","required":["type","scopes","metadataUri","clientId"],"properties":{"type":{"type":"string","enum":["connection"],"description":"Type of OAuth"},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope.","title":"OAuth scopes"},"metadataUri":{"type":"string","description":"Metadata URI for your OAuth authorization server","title":"Metadata URI"},"clientId":{"type":"string","title":"Client ID"}},"title":"Connection-level OAuth configuration"},{"type":"object","required":["usePkce","useJwt"],"properties":{"usePkce":{"type":"boolean","description":"PKCE-enhanced authorization is required for Databricks OAuth.","title":"Use PKCE"},"useJwt":{"type":"boolean","title":"Use JWT"}}}],"title":"Connection-level OAuth"}],"description":"Choose whether to use the same OAuth configuration as the rest of your\n      Sigma organization or configure OAuth specifically for this connection.","title":"OAuth configuration"}},"title":"OAuth"}}},{"type":"object","properties":{"serviceAccount":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Service account"}}}],"title":"OAuth"}],"title":"Authentication"}}},{"type":"object","properties":{"writeAccess":{"allOf":[{"type":"object","required":["writeDestinations"],"properties":{"writeDestinations":{"type":"array","items":{"allOf":[{"type":"object","required":["destination"],"properties":{"destination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"title":"Destination"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the write destination"}}}],"title":"Write destination"},"description":"List of destinations where data can be written","title":"Write destinations"}}},{"type":"object","properties":{"inputTableAuditLogDestination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"description":"Audit log destination"}}}],"description":"Features like CSV upload, materialization, input tables, warehouse views, and\n  running Python code require write access to a destination in your warehouse.","title":"Write access"},"settings":{"allOf":[{"type":"object","properties":{"connectionTimeoutSecs":{"type":"number","description":"Number of seconds Sigma waits for a query to return results before timing out.","title":"Connection timeout"},"connectionQueueSize":{"type":"number","description":"Number of queries that Sigma can concurrently run on this connection.","title":"Connection queue size"},"useFriendlyNames":{"type":"boolean","description":"Whether to change the column names to be more readable. For example, a column \"SALES_JSON\" becomes \"Sales Json\". Defaults to true.","title":"Use friendly names"}},"description":"Configure specific settings for your connection.","title":"Settings"},{"type":"object","properties":{"enableHiveMetastore":{"type":"boolean","description":"To see and use your Hive metastore in Sigma, set to true.","title":"Enable Hive Metastore"}}}],"description":"Configure specific settings for your connection","title":"Settings"},"python":{"type":"object","required":["computeClusterId"],"properties":{"computeClusterId":{"type":"string","description":"Compute cluster ID to run Python queries","title":"Compute cluster ID"}},"description":"Allow users to access data on this connection using Python.","title":"Python configuration"},"sourceSwap":{"type":"object","required":["sourceSwapPolicyId"],"properties":{"sourceSwapPolicyId":{"type":"string","description":"Unique identifier of the source swap policy","title":"Source swap policy ID"}},"description":"Specify a policy to use for dynamically swapping data sources.","title":"Source swap policy"}}}],"title":"Connection details"}},"title":"Connection"}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]},"get":{"summary":"Get connection details (Beta)","description":"Get the metadata of a specific connection by connection ID.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.","parameters":[{"name":"connectionId","schema":{"type":"string","description":"Unique identifier of the connection","title":"Connection ID"},"in":"path","required":true}],"operationId":"v3alpha_getConnection","responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","required":["connectionId","name","details"],"properties":{"connectionId":{"type":"string","description":"Unique identifier of the connection","title":"Connection ID"},"name":{"type":"string","title":"Connection name"},"details":{"allOf":[{"type":"object","required":["type","serverHostname","httpPath","authentication"],"properties":{"type":{"type":"string","enum":["databricks"],"description":"Type of connection"},"serverHostname":{"type":"string","description":"Hostname of the Databricks compute resource"},"httpPath":{"type":"string","description":"HTTP path to connect to the Databricks SQL warehouse or cluster"},"authentication":{"oneOf":[{"type":"object","required":["type","serviceAccount"],"properties":{"type":{"type":"string","enum":["service-account"],"description":"Type of authentication"},"serviceAccount":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Service account"}},"title":"Service account"},{"allOf":[{"type":"object","required":["type","userCredential"],"properties":{"type":{"type":"string","enum":["oauth"],"description":"Type of authentication"},"userCredential":{"type":"object","required":["oauthConfig"],"properties":{"oauthConfig":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["organization"],"description":"Type of OAuth"}},"title":"Organization-level OAuth"},{"allOf":[{"type":"object","required":["type","scopes","metadataUri","clientId"],"properties":{"type":{"type":"string","enum":["connection"],"description":"Type of OAuth"},"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes for Sigma to request from your IdP. Sigma requires the `profile`, `email`, and `openid` scopes. Sigma recommends the `offline_access` scope.","title":"OAuth scopes"},"metadataUri":{"type":"string","description":"Metadata URI for your OAuth authorization server","title":"Metadata URI"},"clientId":{"type":"string","title":"Client ID"}},"title":"Connection-level OAuth configuration"},{"type":"object","required":["usePkce","useJwt"],"properties":{"usePkce":{"type":"boolean","description":"PKCE-enhanced authorization is required for Databricks OAuth.","title":"Use PKCE"},"useJwt":{"type":"boolean","title":"Use JWT"}}}],"title":"Connection-level OAuth"}],"description":"Choose whether to use the same OAuth configuration as the rest of your\n      Sigma organization or configure OAuth specifically for this connection.","title":"OAuth configuration"}},"title":"OAuth"}}},{"type":"object","properties":{"serviceAccount":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["basic-auth"],"description":"Type of authentication"}},"title":"Service account"}}}],"title":"OAuth"}],"title":"Authentication"}}},{"type":"object","properties":{"writeAccess":{"allOf":[{"type":"object","required":["writeDestinations"],"properties":{"writeDestinations":{"type":"array","items":{"allOf":[{"type":"object","required":["destination"],"properties":{"destination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"title":"Destination"}}},{"type":"object","properties":{"description":{"type":"string","description":"Description of the write destination"}}}],"title":"Write destination"},"description":"List of destinations where data can be written","title":"Write destinations"}}},{"type":"object","properties":{"inputTableAuditLogDestination":{"type":"object","required":["catalog","schema"],"properties":{"catalog":{"type":"string","description":"Catalog name"},"schema":{"type":"string","description":"Schema name"}},"description":"Audit log destination"}}}],"description":"Features like CSV upload, materialization, input tables, warehouse views, and\n  running Python code require write access to a destination in your warehouse.","title":"Write access"},"settings":{"allOf":[{"type":"object","properties":{"connectionTimeoutSecs":{"type":"number","description":"Number of seconds Sigma waits for a query to return results before timing out.","title":"Connection timeout"},"connectionQueueSize":{"type":"number","description":"Number of queries that Sigma can concurrently run on this connection.","title":"Connection queue size"},"useFriendlyNames":{"type":"boolean","description":"Whether to change the column names to be more readable. For example, a column \"SALES_JSON\" becomes \"Sales Json\". Defaults to true.","title":"Use friendly names"}},"description":"Configure specific settings for your connection.","title":"Settings"},{"type":"object","properties":{"enableHiveMetastore":{"type":"boolean","description":"To see and use your Hive metastore in Sigma, set to true.","title":"Enable Hive Metastore"}}}],"description":"Configure specific settings for your connection","title":"Settings"},"python":{"type":"object","required":["computeClusterId"],"properties":{"computeClusterId":{"type":"string","description":"Compute cluster ID to run Python queries","title":"Compute cluster ID"}},"description":"Allow users to access data on this connection using Python.","title":"Python configuration"},"sourceSwap":{"type":"object","required":["sourceSwapPolicyId"],"properties":{"sourceSwapPolicyId":{"type":"string","description":"Unique identifier of the source swap policy","title":"Source swap policy ID"}},"description":"Specify a policy to use for dynamically swapping data sources.","title":"Source swap policy"}}}],"title":"Connection details"}},"title":"Connection"}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["connections"]}},"/v3alpha/dataModels/{dataModelId}:swapSources":{"post":{"summary":"Swap data model sources (Beta)","description":"Swap each data source used by a data model. You can swap from one table, dataset, data model element, or custom SQL element to another for each data source.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- Retrieve data model sources by calling the [/v2/dataModels/{dataModelId}/sources](https://help.sigmacomputing.com/reference/list-data-model-sources) endpoint.\n- Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n- Retrieve the **tableId** by calling the [/v2/connection](https://help.sigmacomputing.com/reference/lookup-connection) endpoint.\n- Retrieve the **connectionId** for a new custom SQL element by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n\n- Use the `sourceMapping` options in the request body to swap specific sources. For each source in the source mapping, provide the current source in use in the **from** object, and provide the source that you want to use instead in the **to** object.\n- If your source is a data model with one or more tagged versions, you can also provide a `versionTagId` to swap to or from a tagged version of the data model. The data model version must already be tagged.\n- When swapping **from** a custom SQL element, identify it by its element ID using the `customSqlId` field. When swapping **to** a custom SQL element, supply the `connectionId` of the connection to run against and the SQL query in the `definition` field.\n- If your source is a data model or a dataset, you can use the `metricMapping` option to map metrics that rely on column names from the old source to the new one so that they continue to work.\n- If the source that you swap from uses column names, links, or relationships different from the source that you are swapping to, use the `columnMapping` option to map each column in the original source to a corresponding column in the new source.\n- When `columnMapping` is omitted, columns are automatically matched by display name, ignoring differences in case and punctuation. For example, a custom SQL output column named `DOCK_COUNT` automatically maps to a column with display name `Dock Count` in the target source. Provide `columnMapping` explicitly to override the automatic match for a column.\n\n### Usage scenarios\n- **Data model development**: Use a test data source during development, then swap to a production source when ready.\n- **Dataset migration**: Update references to legacy dataset sources with data model sources by mapping dataset IDs to their new data model equivalents.\n  ","parameters":[{"name":"dataModelId","schema":{"type":"string","description":"The identifier of the data model.","title":"Data model ID"},"in":"path","required":true}],"operationId":"v3alpha_sourceSwapDataModel","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["sourceMapping"],"properties":{"sourceMapping":{"type":"array","items":{"allOf":[{"type":"object","required":["from","to"],"properties":{"from":{"oneOf":[{"type":"object","required":["type","tableId"],"properties":{"type":{"type":"string","enum":["table"]},"tableId":{"type":"string"}},"description":"","title":"Table source"},{"type":"object","required":["type","datasetId"],"properties":{"type":{"type":"string","enum":["dataset"]},"datasetId":{"type":"string"}},"description":"","title":"Dataset source (deprecated)"},{"allOf":[{"type":"object","required":["type","dataModelId","elementId"],"properties":{"type":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string"},"elementId":{"type":"string","description":"ID of the element in the data model","title":"Data model element ID"}}},{"type":"object","properties":{"versionTagId":{"type":"string"}}}],"description":"","title":"Data model source"},{"type":"object","required":["type","customSqlId"],"properties":{"type":{"type":"string","enum":["custom-sql"]},"customSqlId":{"type":"string","description":"ID of the element associated with the custom SQL element.","title":"Custom SQL element ID"}},"description":"","title":"Custom SQL element"}],"description":"Source to swap from.","title":"From data source"},"to":{"oneOf":[{"type":"object","required":["type","tableId"],"properties":{"type":{"type":"string","enum":["table"]},"tableId":{"type":"string"}},"description":"","title":"Table source"},{"type":"object","required":["type","datasetId"],"properties":{"type":{"type":"string","enum":["dataset"]},"datasetId":{"type":"string"}},"description":"","title":"Dataset source (deprecated)"},{"allOf":[{"type":"object","required":["type","dataModelId","elementId"],"properties":{"type":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string"},"elementId":{"type":"string","description":"ID of the element in the data model","title":"Data model element ID"}}},{"type":"object","properties":{"versionTagId":{"type":"string"}}}],"description":"","title":"Data model source"},{"type":"object","required":["type","connectionId","definition"],"properties":{"type":{"type":"string","enum":["custom-sql"]},"connectionId":{"type":"string","description":"ID of the connection that the new custom SQL element will run against.","title":"Connection ID"},"definition":{"type":"string","description":"SQL query that defines the new custom SQL element.","title":"SQL definition"}},"description":"","title":"Custom SQL element"}],"description":"Source to swap to.","title":"To data source"}}},{"type":"object","properties":{"metricMapping":{"type":"array","items":{"type":"object","required":["fromMetricId","toMetricId"],"properties":{"fromMetricId":{"type":"string","description":"Identifier of the metric in the data source","title":"Metric ID"},"toMetricId":{"type":"string","description":"Identifier of the metric in the data source","title":"Metric ID"}}}},"columnMapping":{"type":"array","items":{"type":"object","required":["fromColumn","toColumn"],"properties":{"fromColumn":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Column ID in the form [\"column_id\"]","title":"Column ID"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link in the form [\"link_name\", \"column_name\"]","title":"Link"},{"type":"array","items":{"type":"string"},"description":"Relationship in the form [\"relationship_id\", \"column_name\"]","title":"Relationship"}]},"toColumn":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Column ID in the form [\"column_id\"]","title":"Column ID"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link in the form [\"link_name\", \"column_name\"]","title":"Link"},{"type":"array","items":{"type":"string"},"description":"Relationship in the form [\"relationship_id\", \"column_name\"]","title":"Relationship"}]}}}}}}]}}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["dataModels"]}},"/v3alpha/workbooks/{workbookId}:swapSources":{"post":{"summary":"Swap workbook sources (Beta)","description":"Swap each data source used by a workbook. You can swap from one table, dataset, data model element, or custom SQL element to another for each data source.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve workbook sources by calling the [/v2/workbooks/{workbookId}/sources](https://help.sigmacomputing.com/reference/get-workbook-sources) endpoint.\n- Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\n- Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint.\n- Retrieve the **tableId** by calling the [/v2/connection](https://help.sigmacomputing.com/reference/lookup-connection) endpoint.\n- Retrieve the **connectionId** for a new custom SQL element by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n\n- Use the `sourceMapping` options in the request body to swap specific sources. For each source in the source mapping, provide the current source in use in the **from** object, and provide the source that you want to use instead in the **to** object.\n- If your source is a data model with one or more tagged versions, you can also provide a `versionTagId` to swap to or from a tagged version of the data model. The data model version must already be tagged.\n- When swapping **from** a custom SQL element, identify it by its element ID using the `customSqlId` field. When swapping **to** a custom SQL element, supply the `connectionId` of the connection to run against and the SQL query in the `definition` field.\n- If your source is a data model or a dataset, you can use the `metricMapping` option to map metrics that rely on column names from the old source to the new one so that they continue to work.\n- If the source that you swap from uses column names, links, or relationships different from the source that you are swapping to, use the `columnMapping` option to map each column in the original source to a corresponding column in the new source.\n- When `columnMapping` is omitted, columns are automatically matched by display name, ignoring differences in case and punctuation. For example, a custom SQL output column named `DOCK_COUNT` automatically maps to a data model column with display name `Dock Count`. Provide `columnMapping` explicitly to override the automatic match for a column.\n\n### Usage scenarios\n- **Workbook development**: Use a test data source during development, then swap to a production source when ready to share the workbook.\n- **Dataset migration**: Update references to deprecated dataset sources with data model sources by mapping dataset IDs to their new data model equivalents.\n","parameters":[{"name":"workbookId","schema":{"type":"string","description":"Unique identifier of the workbook.","title":"Workbook ID"},"in":"path","required":true}],"operationId":"v3alpha_sourceSwapWorkbook","requestBody":{"description":"The request body.","content":{"application/json":{"schema":{"type":"object","required":["sourceMapping"],"properties":{"sourceMapping":{"type":"array","items":{"allOf":[{"type":"object","required":["from","to"],"properties":{"from":{"oneOf":[{"type":"object","required":["type","tableId"],"properties":{"type":{"type":"string","enum":["table"]},"tableId":{"type":"string"}},"description":"","title":"Table source"},{"type":"object","required":["type","datasetId"],"properties":{"type":{"type":"string","enum":["dataset"]},"datasetId":{"type":"string"}},"description":"","title":"Dataset source (deprecated)"},{"allOf":[{"type":"object","required":["type","dataModelId","elementId"],"properties":{"type":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string"},"elementId":{"type":"string","description":"ID of the element in the data model","title":"Data model element ID"}}},{"type":"object","properties":{"versionTagId":{"type":"string"}}}],"description":"","title":"Data model source"},{"type":"object","required":["type","customSqlId"],"properties":{"type":{"type":"string","enum":["custom-sql"]},"customSqlId":{"type":"string","description":"ID of the element associated with the custom SQL element.","title":"Custom SQL element ID"}},"description":"","title":"Custom SQL element"}],"description":"Source to swap from.","title":"From data source"},"to":{"oneOf":[{"type":"object","required":["type","tableId"],"properties":{"type":{"type":"string","enum":["table"]},"tableId":{"type":"string"}},"description":"","title":"Table source"},{"type":"object","required":["type","datasetId"],"properties":{"type":{"type":"string","enum":["dataset"]},"datasetId":{"type":"string"}},"description":"","title":"Dataset source (deprecated)"},{"allOf":[{"type":"object","required":["type","dataModelId","elementId"],"properties":{"type":{"type":"string","enum":["data-model"]},"dataModelId":{"type":"string"},"elementId":{"type":"string","description":"ID of the element in the data model","title":"Data model element ID"}}},{"type":"object","properties":{"versionTagId":{"type":"string"}}}],"description":"","title":"Data model source"},{"type":"object","required":["type","connectionId","definition"],"properties":{"type":{"type":"string","enum":["custom-sql"]},"connectionId":{"type":"string","description":"ID of the connection that the new custom SQL element will run against.","title":"Connection ID"},"definition":{"type":"string","description":"SQL query that defines the new custom SQL element.","title":"SQL definition"}},"description":"","title":"Custom SQL element"}],"description":"Source to swap to.","title":"To data source"}}},{"type":"object","properties":{"metricMapping":{"type":"array","items":{"type":"object","required":["fromMetricId","toMetricId"],"properties":{"fromMetricId":{"type":"string","description":"Identifier of the metric in the data source","title":"Metric ID"},"toMetricId":{"type":"string","description":"Identifier of the metric in the data source","title":"Metric ID"}}}},"columnMapping":{"type":"array","items":{"type":"object","required":["fromColumn","toColumn"],"properties":{"fromColumn":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Column ID in the form [\"column_id\"]","title":"Column ID"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link in the form [\"link_name\", \"column_name\"]","title":"Link"},{"type":"array","items":{"type":"string"},"description":"Relationship in the form [\"relationship_id\", \"column_name\"]","title":"Relationship"}]},"toColumn":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Column ID in the form [\"column_id\"]","title":"Column ID"},{"type":"array","items":{"type":"string"},"description":"Dataset or table link in the form [\"link_name\", \"column_name\"]","title":"Link"},{"type":"array","items":{"type":"string"},"description":"Relationship in the form [\"relationship_id\", \"column_name\"]","title":"Relationship"}]}}}}}}]}}}}}}},"responses":{"200":{"description":"The response body.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"default":{"$ref":"#/components/responses/ApiError"}},"externalDocs":{"url":"","description":"Sigma API documentation:"},"tags":["workbooks"]}}},"tags":[{"name":"accountTypes"},{"name":"allowedIps"},{"name":"allowedIps\\:batchCreate"},{"name":"allowedIps\\:batchDelete"},{"name":"api-connectors"},{"name":"api-credentials"},{"name":"auth"},{"name":"connections"},{"name":"credentials"},{"name":"dataModels"},{"name":"datasets"},{"name":"deploymentPolicies"},{"name":"favorites"},{"name":"files"},{"name":"grants"},{"name":"members"},{"name":"organizations"},{"name":"plugins"},{"name":"query"},{"name":"reports"},{"name":"saml"},{"name":"shared_templates"},{"name":"shortcuts"},{"name":"sourceSwapPolicies"},{"name":"tags"},{"name":"teams"},{"name":"templates"},{"name":"tenants"},{"name":"translations"},{"name":"user-attributes"},{"name":"webhooks"},{"name":"whoami"},{"name":"workbookAgents"},{"name":"workbooks"},{"name":"workspaces"}],"servers":[{"url":"https://api.sigmacomputing.com","description":"Server for GCP (US) hosted organizations"},{"url":"https://api.sa.gcp.sigmacomputing.com","description":"Server for GCP (KSA) hosted organizations"},{"url":"https://aws-api.sigmacomputing.com","description":"Server for AWS US (West) hosted organizations"},{"url":"https://api.us-a.aws.sigmacomputing.com","description":"Server for AWS US (East) hosted organizations"},{"url":"https://api.ca.aws.sigmacomputing.com","description":"Server for AWS Canada hosted organizations"},{"url":"https://api.eu.aws.sigmacomputing.com","description":"Server for AWS Europe hosted organizations"},{"url":"https://api.au.aws.sigmacomputing.com","description":"Server for AWS Australia and APAC hosted organizations"},{"url":"https://api.uk.aws.sigmacomputing.com","description":"Server for AWS UK hosted organizations"},{"url":"https://api.us.azure.sigmacomputing.com","description":"Server for Azure US hosted organizations"},{"url":"https://api.eu.azure.sigmacomputing.com","description":"Server for Azure Europe hosted organizations"},{"url":"https://api.ca.azure.sigmacomputing.com","description":"Server for Azure Canada hosted organizations"},{"url":"https://api.uk.azure.sigmacomputing.com","description":"Server for Azure United Kingdom hosted organizations"},{"url":"https://api.au.azure.sigmacomputing.com","description":"Server for Azure Australia hosted organizations"}]}